Amongst other enhancements, this package offers:
Enhancements for Sphinx’s intersphinx system to provide per-page intersphinx resolution options (useful for pages, such as release notes, that need to link to different versions of the same docs, such as Django or Python)
Linking code references to GitHub documentation
High-DPI image embedding
A role for HTTP status codes
It’s very easy to get going. Just install
beanbag-docutils like so:
$ pip install beanbag-docutils
We like to place ours in a
doc-requirements.txt file in each of our
repositories, and use:
$ pip install -r doc-requirements.txt
The following extensions are provided:
Enables parsing of the Beanbag docstring format for Python.
Advanced options for defining excluded and deprecated classes/functions to skip, either in a Sphinx project’s
conf.pyor directly in the Python modules.
Allows arbitrary supplemental files to be “collected” along with any of your documentation.
Roles and directives for describing Django-related concepts in your documentation.
Automatic support for resolving “lazy” localized strings, so they appear correctly.
An improved version of Sphinx’s own
sphinx.ext.extlinksthat supports anchors in the string passed to the role (e.g.,
Provides links to the appropriate versions of the tree in GitHub for any source code references, instead of bundling copies of the source code with the documentation.
httprole for specifying HTTP status codes and linking them to useful documentation.
Collects all high-DPI versions of images (e.g., any with a
@2xin the filename) for the resulting documentation.
Review Board - Our extensible open source code review product.
RBCommons - Our Review Board SaaS.
Django Evolution - Advanced schema migration for Django, compatible with Django’s migrations.
Djblets - A set of utilities and infrastructure for Django-based projects.
kgb - Function spies for Python unit tests.
RBTools - Command line tools for Review Board and RBCommons.