beanbaginc / beanbag-docutils

Documentation utilities for Beanbag products.
MIT License
5 stars 4 forks source link
python sphinx sphinx-doc sphinx-extension

===================== Beanbag Doc Utilities

This is a collection of utilities to help with generating documentation for Beanbag-related products, including:

.. _Review Board: https://www.reviewboard.org/ .. _RBCommons: https://www.rbcommons.com/ .. _Djblets: https://github.com/djblets/djblets/ .. _RBTools: https://github.com/reviewboard/rbtools/

Sphinx Extensions

Most of the utilities are used with the Sphinx_ documentation system. Amongst other enhancements, this package offers:

.. _Beanbag docstring format: https://www.notion.so/reviewboard/Standard-Documentation-Format-4388f594d86547cc949b365cda3cf391 .. _Django: https://www.djangoproject.com/ .. _Google docstring format: https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings .. _intersphinx: https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html .. _our products: https://www.beanbaginc.com/ .. _ReStructuredText: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html .. _Sphinx: https://www.sphinx-doc.org/

Compatibility

Getting Started

To install the package, run:

.. code-block:: shell

$ pip install beanbag-docutils

See the documentation_ for usage information.

.. _documentation: https://beanbag-docutils.readthedocs.io/