Skip to content

Commit 5221bfc

Browse files
authored
Refresh the list of third-party domains (#13691)
1 parent bb9cf58 commit 5221bfc

File tree

1 file changed

+63
-37
lines changed

1 file changed

+63
-37
lines changed

doc/usage/domains/index.rst

Lines changed: 63 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,69 @@ easier to write.
3535
This section describes what the domains that are included with Sphinx provide.
3636
The domain API is documented as well, in the section :ref:`domain-api`.
3737

38+
Built-in domains
39+
----------------
40+
41+
The following domains are included within Sphinx:
42+
43+
.. toctree::
44+
:maxdepth: 1
45+
46+
standard
47+
c
48+
cpp
49+
javascript
50+
mathematics
51+
python
52+
restructuredtext
53+
54+
55+
Third-party domains
56+
-------------------
57+
58+
Several third-party domains are available as extensions, including:
59+
60+
* `Ada <https://pypi.org/project/sphinxcontrib-adadomain/>`__
61+
* `Antlr4 <https://pypi.org/project/sphinx-a4doc/>`__
62+
* `Bazel <https://pypi.org/project/sphinx-bazel/>`__
63+
* `BibTex <https://pypi.org/project/sphinxcontrib-bibtex/>`__
64+
* `Chapel <https://pypi.org/project/sphinxcontrib-chapeldomain/>`__
65+
* `CMake <https://pypi.org/project/sphinxcontrib-moderncmakedomain/>`__
66+
* `Common Lisp <https://pypi.org/project/sphinxcontrib-cldomain/>`__
67+
* `Erlang <https://pypi.org/project/sphinxcontrib-erlangdomain/>`__
68+
* `Fortran <https://pypi.org/project/sphinx-fortran/>`__
69+
* `GraphQL <https://pypi.org/project/graphqldomain/>`__
70+
* `Go <https://pypi.org/project/sphinxcontrib-golangdomain/>`__
71+
* `HTTP <https://pypi.org/project/sphinxcontrib-httpdomain/>`__
72+
* `Hy <https://pypi.org/project/sphinxcontrib-hydomain/>`__
73+
* `Lua <https://pypi.org/project/sphinxcontrib-luadomain/>`__
74+
* `MATLAB <https://pypi.org/project/sphinxcontrib-matlabdomain/>`__
75+
* `PHP <https://pypi.org/project/sphinxcontrib-phpdomain/>`__
76+
* `Ruby <https://pypi.org/project/sphinxcontrib-rubydomain/>`__
77+
* `Rust <https://pypi.org/project/sphinxcontrib-rust/>`__
78+
* `Verilog <https://pypi.org/project/sphinx-verilog-domain/>`__
79+
* `VHDL <https://pypi.org/project/sphinx-vhdl/>`__
80+
* `Visual Basic <https://pypi.org/project/sphinx-vb-domain/>`__
81+
82+
Other domains may be found on the Python Package Index
83+
(via the `Framework :: Sphinx :: Domain`__ classifier),
84+
`GitHub <https://github.com/search?q=sphinx%20domain&type=repositories>`__, or
85+
`GitLab <https://gitlab.com/explore/projects?name=sphinx%20domain>`__.
86+
87+
__ https://pypi.org/search/?c=Framework+%3A%3A+Sphinx+%3A%3A+Domain
88+
89+
.. NOTE: The following all seem unmaintained, last released 2018 or earlier.
90+
The links are preserved in this comment for reference.
91+
92+
* `CoffeeScript <https://pypi.org/project/sphinxcontrib-coffee/>`__
93+
* `DotNET <https://pypi.org/project/sphinxcontrib-dotnetdomain/>`__
94+
* `dqn <https://pypi.org/project/sphinxcontrib-dqndomain/>`__
95+
* `Jinja <https://pypi.org/project/sphinxcontrib-jinjadomain/>`__
96+
* `JSON <https://pypi.org/project/sphinx-jsondomain/>`__
97+
* `Lasso <https://pypi.org/project/sphinxcontrib-lassodomain/>`__
98+
* `Operation <https://pypi.org/project/sphinxcontrib-operationdomain/>`__
99+
* `Scala <https://pypi.org/project/sphinxcontrib-scaladomain/>`__
100+
38101
39102
.. _basic-domain-markup:
40103

@@ -174,40 +237,3 @@ In short:
174237
component of the target.
175238
For example, ``:py:meth:`~queue.Queue.get``` will
176239
refer to ``queue.Queue.get`` but only display ``get`` as the link text.
177-
178-
Built-in domains
179-
----------------
180-
181-
The following domains are included within Sphinx:
182-
183-
.. toctree::
184-
:maxdepth: 1
185-
186-
standard
187-
c
188-
cpp
189-
javascript
190-
mathematics
191-
python
192-
restructuredtext
193-
194-
More domains
195-
------------
196-
197-
There are several third-party domains available as extensions, including:
198-
199-
* `Ada <https://pypi.org/project/sphinxcontrib-adadomain/>`__
200-
* `Chapel <https://pypi.org/project/sphinxcontrib-chapeldomain/>`__
201-
* `CoffeeScript <https://pypi.org/project/sphinxcontrib-coffee/>`__
202-
* `Common Lisp <https://pypi.org/project/sphinxcontrib-cldomain/>`__
203-
* `dqn <https://pypi.org/project/sphinxcontrib-dqndomain/>`__
204-
* `Erlang <https://pypi.org/project/sphinxcontrib-erlangdomain/>`__
205-
* `Go <https://pypi.org/project/sphinxcontrib-golangdomain/>`__
206-
* `HTTP <https://pypi.org/project/sphinxcontrib-httpdomain/>`__
207-
* `Jinja <https://pypi.org/project/sphinxcontrib-jinjadomain/>`__
208-
* `Lasso <https://pypi.org/project/sphinxcontrib-lassodomain/>`__
209-
* `MATLAB <https://pypi.org/project/sphinxcontrib-matlabdomain/>`__
210-
* `Operation <https://pypi.org/project/sphinxcontrib-operationdomain/>`__
211-
* `PHP <https://pypi.org/project/sphinxcontrib-phpdomain/>`__
212-
* `Ruby <https://pypi.org/project/sphinxcontrib-rubydomain/>`__
213-
* `Scala <https://pypi.org/project/sphinxcontrib-scaladomain/>`__

0 commit comments

Comments
 (0)