ReStructuredText and Sphinx bridge to Doxygen

Packagers: PGP signing key changes for Breathe >= v4.23.0. https://github.com/michaeljones/breathe/issues/591 This is an extension to reStructuredText and Sphinx to be able to read and render the Doxygen xml output. Download Breathe is available from github and PyPI, the Python Package Index. It can be installed with: pip install breathe Documentation The documentation is available here. Thank you to the people running Read the Docs for such an excellent service. The source for the documentation is in the documentation folder if […]

Read more

Watch a Sphinx directory and rebuild the documentation when a change is detected

Rebuild Sphinx documentation on changes, with live-reload in the browser. Installation sphinx-autobuild is available on PyPI. It can be installed using pip: pip install sphinx-autobuild Usage To build a classical Sphinx documentation set, run: sphinx-autobuild docs docs/_build/html This will start a server at http://127.0.0.1:8000 and start watching for changes in the docs/ directory. When a change is detected in docs/, the documentation is rebuilt and any open browser windows are reloaded automatically. KeyboardInterrupt (ctrl+c) will stop the server. Command line […]

Read more

Type hints support for the Sphinx autodoc extension

This extension allows you to use Python 3 annotations for documenting acceptable argument types and return value types of functions. This allows you to use type hints in a very natural fashion, allowing you to migrate from this: def format_unit(value, unit): “”” Formats the given value as a human readable string using the given units. :param float|int value: a numeric value :param str unit: the unit for the value (kg, m, etc.) :rtype: str “”” return ‘{} {}’.format(value, unit) to […]

Read more

Adds needs/requirements to sphinx

sphinxcontrib-needs Sphinx-Needs allows the definition, linking and filtering of class-like need-objects, which are by default: requirements specifications implementations test cases. This list can be easily customized via configuration (for instance to support bugs or user stories). A default requirement need looks like: Layout and style of needs can be highly customized, so that a need can also look like: Take a look into our Examples for more pictures and ideas how to use Sphinx-Needs. For filtering and analyzing needs, Sphinx-Needs […]

Read more