beanbag-docutils

Sphinx utility modules for Beanbag's documentation format.


Keywords
python, sphinx, sphinx-doc, sphinx-extension
License
MIT
Install
pip install beanbag-docutils==2.0

Documentation

Beanbag Doc Utilities

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

  • 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.

Compatibility

  • beanbag-docutils 2.x supports Python 3.6-3.11.
  • beanbag-docutils 1.x supports Python 2.7 and 3.6-3.10.

Getting Started

To install the package, run:

$ pip install beanbag-docutils

See the documentation for usage information.