beanbag-docutils is a set of extensions to the Sphinx ReStructuredText-based documentation system used by our products to help generate better documentation. Amongst other enhancements, it provides:
- A parser for the Beanbag docstring format, a variation on the Google docstring format, which we use for Python and JavaScript documentation
- 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)
- Enhancements to ReStructuredText references to let a reference name span lines (useful for long Python/JavaScript module/class names)
- Linking code references to GitHub documentation
- High-DPI image embedding
- A role for HTTP status codes
Today’s release of beanbag-docutils 2.0 features:
- Python 3.11 support, and the removal of Python 2.7
- Improved Sphinx configuration defaults when using
autodoc_utils. - New autodoc sections for documenting attribute/property types (
Type:), dictionary keys (Keys:), and tuples (Tuple:) - Fixes for lists within version sections (
Version Added:,Version Changed:, andDeprecated:) - Fixes and improvements for linking to code on GitHub
See the release notes for the full list of changes.
