IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Expand and update list of extensions

Browse Source 
Updated from https://bitbucket.org/birkenfeld/sphinx-contrib/
This commit is contained in:
Sanjeev Gupta 2017-06-02 04:11:48 +08:00
parent a259df7dea
commit a561fdb8c1
2 changed files with 34 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
doc/develop.rst
View File

@ -27,19 +27,27 @@ releases on PyPI, others you can install from a checkout.
This is the current list of contributed extensions in that repository: This is the current list of contributed extensions in that repository:
- aafig: render embedded ASCII art as nice images using aafigure_. - aafig: render embedded ASCII art as nice images using aafigure_
- actdiag: embed activity diagrams by using actdiag_ - actdiag: embed activity diagrams by using actdiag_
- adadomain: an extension for Ada support (Sphinx 1.0 needed) - adadomain: an extension for Ada support (Sphinx 1.0 needed)
- ansi: parse ANSI color sequences inside documents - ansi: parse ANSI color sequences inside documents
- autorun: Execute code in a ``runblock`` directive. - argdoc: automatically generate documentation for command-line arguments, descriptions, and help text
- astah: embed diagram by using astah
- autoanysrc: Gather reST documentation from any source files
- autorun: Execute code in a ``runblock`` directive
- blockdiag: embed block diagrams by using blockdiag_ - blockdiag: embed block diagrams by using blockdiag_
- cacoo: embed diagram from Cacoo
- cf3domain: a domain for CFEngine 3 policies
- cheader: The missing c:header directive for Sphinx's built-in C domain
- cheeseshop: easily link to PyPI packages - cheeseshop: easily link to PyPI packages
- clearquest: create tables from ClearQuest_ queries. - clearquest: create tables from ClearQuest_ queries
- cmakedomain_: a domain for CMake_ - cmakedomain_: a domain for CMake_
- coffeedomain: a domain for (auto)documenting CoffeeScript source code. - coffeedomain: a domain for (auto)documenting CoffeeScript source code
- context: a builder for ConTeXt. - context: a builder for ConTeXt
- disqus: embed Disqus comments in documents
- documentedlist: converts a Python list to a table in the generated documentation
- doxylink: Link to external Doxygen-generated HTML documentation - doxylink: Link to external Doxygen-generated HTML documentation
- domaintools_: A tool for easy domain creation. - domaintools_: A tool for easy domain creation
- email: obfuscate email addresses - email: obfuscate email addresses
- erlangdomain: an extension for Erlang support (Sphinx 1.0 needed) - erlangdomain: an extension for Erlang support (Sphinx 1.0 needed)
- exceltable: embed Excel spreadsheets into documents using exceltable_ - exceltable: embed Excel spreadsheets into documents using exceltable_
@ -47,47 +55,49 @@ This is the current list of contributed extensions in that repository:
from your site content from your site content
- findanything_: an extension to add Sublime Text 2-like findanything panels - findanything_: an extension to add Sublime Text 2-like findanything panels
to your documentation to find pages, sections and index entries while typing to your documentation to find pages, sections and index entries while typing
- gnuplot: produces images using gnuplot_ language. - gnuplot: produces images using gnuplot_ language
- googleanalytics: track web visitor statistics by using `Google Analytics`_ - googleanalytics: track web visitor statistics by using `Google Analytics`_
- googlechart: embed charts by using `Google Chart`_ - googlechart: embed charts by using `Google Chart`_
- googlemaps: embed maps by using `Google Maps`_ - googlemaps: embed maps by using `Google Maps`_
- httpdomain: a domain for documenting RESTful HTTP APIs. - httpdomain: a domain for documenting RESTful HTTP APIs
- hyphenator: client-side hyphenation of HTML using hyphenator_ - hyphenator: client-side hyphenation of HTML using hyphenator_
- imgur: embed Imgur images, albums, and metadata in documents
- inlinesyntaxhighlight_: inline syntax highlighting - inlinesyntaxhighlight_: inline syntax highlighting
- lassodomain: a domain for documenting Lasso_ source code - lassodomain: a domain for documenting Lasso_ source code
- libreoffice: an extension to include any drawing supported by LibreOffice (e.g. odg, vsd, ...). - libreoffice: an extension to include any drawing supported by LibreOffice (e.g. odg, vsd, ...)
- lilypond: an extension inserting music scripts from Lilypond_ in PNG format. - lilypond: an extension inserting music scripts from Lilypond_ in PNG format
- makedomain_: a domain for `GNU Make`_ - makedomain_: a domain for `GNU Make`_
- matlabdomain: document MATLAB_ code. - matlabdomain: document MATLAB_ code
- mockautodoc: mock imports. - mockautodoc: mock imports
- mscgen: embed mscgen-formatted MSC (Message Sequence Chart)s. - mscgen: embed mscgen-formatted MSC (Message Sequence Chart)s
- napoleon: supports `Google style`_ and `NumPy style`_ docstrings. - napoleon: supports `Google style`_ and `NumPy style`_ docstrings
- nicovideo: embed videos from nicovideo - nicovideo: embed videos from nicovideo
- nwdiag: embed network diagrams by using nwdiag_ - nwdiag: embed network diagrams by using nwdiag_
- omegat: support tools to collaborate with OmegaT_ (Sphinx 1.1 needed) - omegat: support tools to collaborate with OmegaT_ (Sphinx 1.1 needed)
- osaka: convert standard Japanese doc to Osaka dialect (this is a joke extension) - osaka: convert standard Japanese doc to Osaka dialect (this is a joke extension)
- paverutils: an alternate integration of Sphinx with Paver_. - paverutils: an alternate integration of Sphinx with Paver_
- phpdomain: an extension for PHP support - phpdomain: an extension for PHP support
- plantuml: embed UML diagram by using PlantUML_ - plantuml: embed UML diagram by using PlantUML_
- py_directive: Execute python code in a ``py`` directive and return a math - py_directive: Execute python code in a ``py`` directive and return a math
node. node
- rawfiles: copy raw files, like a CNAME. - rawfiles: copy raw files, like a CNAME
- requirements: declare requirements wherever you need (e.g. in test - requirements: declare requirements wherever you need (e.g. in test
docstrings), mark statuses and collect them in a single list docstrings), mark statuses and collect them in a single list
- restbuilder: a builder for reST (reStructuredText) files. - restbuilder: a builder for reST (reStructuredText) files
- rubydomain: an extension for Ruby support (Sphinx 1.0 needed) - rubydomain: an extension for Ruby support (Sphinx 1.0 needed)
- sadisplay: display SqlAlchemy model sadisplay_ - sadisplay: display SqlAlchemy model sadisplay_
- sdedit: an extension inserting sequence diagram by using Quick Sequence - sdedit: an extension inserting sequence diagram by using Quick Sequence
Diagram Editor (sdedit_) Diagram Editor (sdedit_)
- seqdiag: embed sequence diagrams by using seqdiag_ - seqdiag: embed sequence diagrams by using seqdiag_
- slide: embed presentation slides on slideshare_ and other sites. - slide: embed presentation slides on slideshare_ and other sites
- swf_: embed flash files - swf_: embed flash files
- sword: an extension inserting Bible verses from Sword_. - sword: an extension inserting Bible verses from Sword_
- tikz: draw pictures with the `TikZ/PGF LaTeX package`_. - tikz: draw pictures with the `TikZ/PGF LaTeX package`_
- traclinks: create TracLinks_ to a Trac_ instance from within Sphinx - traclinks: create TracLinks_ to a Trac_ instance from within Sphinx
- versioning: Sphinx extension that allows building versioned docs for self-hosting
- whooshindex: whoosh indexer extension - whooshindex: whoosh indexer extension
- youtube: embed videos from YouTube_ - youtube: embed videos from YouTube_
- zopeext: provide an ``autointerface`` directive for using `Zope interfaces`_. - zopeext: provide an ``autointerface`` directive for using `Zope interfaces`_
See the :ref:`extension tutorial <exttut>` on getting started with writing your See the :ref:`extension tutorial <exttut>` on getting started with writing your

4
doc/domains.rst
View File

@ -34,8 +34,8 @@ documentation wants to refer to e.g. C++ and Python classes. It also means that
extensions that support the documentation of whole new languages are much easier extensions that support the documentation of whole new languages are much easier
to write. to write.
This section describes what the domains that come with Sphinx provide. The This section describes what the domains that are included with Sphinx provide.
domain API is documented as well, in the section :ref:`domain-api`. The domain API is documented as well, in the section :ref:`domain-api`.
.. _basic-domain-markup: .. _basic-domain-markup: