sphinxnotes-any#

Sphinx domain for documenting anything.

Documentation: https://sphinx.silverrainz.me/any
Source: https://github.com/sphinx-notes/any
Changelog: https://sphinx.silverrainz.me/any/changelog.html
Tracker: https://github.com/sphinx-notes/any/issues
Download: https://pypi.org/project/sphinxnotes-any/#files

Introduction#

The extension provides a domain which allows user creates directive and roles to descibe, reference and index arbitrary object in documentation. It is a bit like sphinx.application.Sphinx.add_object_type(), but more powerful.

Getting Started#

Note

We assume you already have a Sphinx documentation, if not, see Getting Started with Sphinx.

First, downloading extension from PyPI:

$ pip install sphinxnotes-any

Then, add the extension name to extensions configuration item in your conf.py:

extensions = [
          # …
          'sphinxnotes.any',
          # …
          ]

See Usage and Configuration for more details.

Contents#

The Sphinx Notes Project#

The project is developed by Shengyu Zhang, as part of The Sphinx Notes Project.

The Sphinx Notes Project