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


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


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:

.. code-block:: shell

   $ pip install beanbag-docutils


See the documentation_ for usage information.


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