.. -*- restructuredtext -*- ========================= README for sphinx-contrib ========================= This repository contains a collection of Sphinx_ extensions maintained by their respective authors. It is not an official part of Sphinx. .. _Sphinx: Installing ========== Use ```` in the subdirectory for the individual extension:: cd dir python build sudo python install Contributing ============ If you want to add your own extension, please write an e-mail to and give your bitbucket user name; you will then get write access to the public repo at Send wishes, comments, patches, etc. for individual extensions to their author as given in the module. List of extensions ================== .. Note that this will be viewed using the bitbucket web interface .. .. which supports a subset, but not the full sphinx markup. .. - aafig: render embedded ASCII art as nice images using aafigure_. - actdiag: embed activity diagrams by using actdiag_ - adadomain: an extension for Ada support (Sphinx 1.0 needed) - ansi: parse ANSI color sequences inside documents - 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 - autoprogram_: documenting CLI programs - autorun: Execute code in a ``runblock`` directive. - 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 - clearquest: create tables from ClearQuest_ queries. - cmakedomain_: a domain for CMake_ - coffeedomain: a domain for (auto)documenting CoffeeScript source code. - confluencebuilder_: build Confluence-supported markup and optionally publish to a Confluence server - 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 - domaintools_: A tool for easy domain creation. - email: obfuscate email addresses - erlangdomain: an extension for Erlang support (Sphinx 1.0 needed) - examplecode: this extension adds support for a multiple language code block widget to Sphinx_. - exceltable_: embed Excel spreadsheets into documents - feed: an extension for creating syndication feeds and time-based overviews from your site content - findanything_: an extension to add Sublime Text 2-like findanything panels to your documentation to find pages, sections and index entries while typing - gnuplot: produces images using gnuplot_ language. - googleanalytics: track web visitor statistics by using `Google Analytics`_ - googlechart: embed charts by using `Google Chart`_ - googlemaps: embed maps by using `Google Maps`_ - httpdomain_: a domain for documenting RESTful HTTP APIs. - hyphenator: client-side hyphenation of HTML using hyphenator_ - imgur_: embed Imgur images, albums, and metadata in documents. - inlinesyntaxhighlight_: inline syntax highlighting - lassodomain_: a domain for documenting Lasso_ source code - 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. - makedomain_: a domain for `GNU Make`_ - matlabdomain_: document MATLAB_ and `GNU Octave`_ code. - mockautodoc: mock imports. - mscgen: embed mscgen-formatted MSC (Message Sequence Chart)s. - napoleon: supports `Google style`_ and `NumPy style`_ docstrings. - nicoviceo: embed videos from nicovideo - nwdiag: embed network diagrams by using nwdiag_ - omegat: support tools to collaborate with OmegaT_ (Sphinx 1.1 needed) - osaka: convert standard Japanese doc to Osaka dialect (it is joke extension) - paverutils: an alternate integration of Sphinx with Paver_. - phpdomain: an extension for PHP support - plantuml: embed UML diagram by using PlantUML_ - py_directive: Execute python code in a ``py`` directive and return a math node. - rawfiles: copy raw files, like a CNAME. - requirements: declare requirements wherever you need (e.g. in test docstrings), mark statuses and collect them in a single list - restbuilder: a builder for reST (reStructuredText) files. - rubydomain: an extension for Ruby support (Sphinx 1.0 needed) - sadisplay: display SqlAlchemy model sadisplay_ - sdedit: an extension inserting sequence diagram by using Quick Sequence Diagram Editor (sdedit_) - seqdiag: embed sequence diagrams by using seqdiag_ - slide: embed presentation slides on slideshare_ and other sites. - swf_: embed flash files - sword: an extension inserting Bible verses from Sword_. - tikz: draw pictures with the `TikZ/PGF LaTeX package`_. - 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 - youtube: embed videos from YouTube_ - zopeext: provide an ``autointerface`` directive for using `Zope interfaces`_. .. _aafigure: .. _argdoc: .. _astah: .. _autoprogram: .. _Cacoo: .. _confluencebuilder: .. _gnuplot: .. _paver: .. _Sword: .. _Lilypond: .. _sdedit: .. _Trac: .. _TracLinks: .. _OmegaT: .. _PlantUML: .. _PyEnchant: .. _sadisplay: .. _blockdiag: .. _seqdiag: .. _actdiag: .. _nwdiag: .. _Google Analytics: .. _Google Chart: .. _Google Maps: .. _Google style: .. _NumPy style: .. _hyphenator: .. _exceltable: .. _YouTube: .. _ClearQuest: .. _Zope interfaces: .. _slideshare: .. _TikZ/PGF LaTeX package: .. _MATLAB: .. _GNU Octave: .. _matlabdomain: .. _swf: .. _findanything: .. _cmakedomain: .. _GNU Make: .. _makedomain: .. _inlinesyntaxhighlight: .. _CMake: .. _domaintools: .. _restbuilder: .. _lassodomain: .. _Lasso: .. _httpdomain: .. _cheader: .. _CFEngine 3: .. _disqus: .. _imgur: .. _versioning: .. _documentedlist: For contributors ================ When adding or updating your extension, please adhere to these guidelines: * Use ```` to set up your extension subdirectory. * Each extension must be either a submodule or subpackage of the ``sphinxcontrib`` package. The ``sphinxcontrib/`` file in your package must not be changed. * Each extension must be listed in this file under "List of extensions" above. * Each author should be listed in ``AUTHORS`` along with the extension name. * It would be good to have all extensions BSD licensed; otherwise make a note in an ``ext/LICENSE`` file. * Each extension can maintain a changelog and readme file; these files should be called ``ext/CHANGES`` and ``ext/README.rst``, respectively.