# Beanbag Documentation Utilities     **GitHub:** https://github.com/beanbaginc/beanbag-docutils **PyPI:** https://pypi.org/project/beanbag-docutils **Status:** Under active development / released / used in production This is a collection of utilities to help with generating documentation for Beanbag-related products, including: - [[Projects/Beanbag — Core Products/Review Board|Review Board]] - Our widely-used open source code review product. - [[RBCommons]] - Our Review Board SaaS. - [[Djblets]] - A set of utilities and infrastructure for Django-based projects. - [[RBTools]] - Command line tools for Review Board and RBCommons. ## Sphinx Extensions Most of the utilities are used with the [[Sphinx]] documentation system. Amongst other enhancements, this package offers: - A parser for the [Beanbag docstring format](https://www.notion.so/reviewboard/Standard-Documentation-Format-4388f594d86547cc949b365cda3cf391) (a variation on the [Google docstring format](https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings)), which we use for Python and JavaScript documentation - Enhancements for Sphinx's [intersphinx](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html) 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 [[Registries]]) - 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 - Access to document-defined metadata in a structured form when parsing documents