This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description

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.

Sphinx Extensions

We use Sphinx for our documentation, and have a number of extensions to help with the generation of docs.


Enhances autodoc support to allow for excluding content from docs.

A module can define top-level __autodoc_excludes__ or __deprecated__ lists. These are in the same format as __all__, in that they take a list of strings for top-level classes, functions, and variables. Anything listed here will be excluded from any autodoc code.

__autodoc_excludes__ is particularly handy when documenting an that imports contents from a submodule and re-exports it in __all__. In this case, autodoc would normally output documentation both in and the submodule, but that can be avoided by setting:

__autodoc_excludes = __all__

Excludes can also be defined globally, filtered by the type of object the docstring would belong to. See the documentation for autodoc-skip-member for more information. You can configure this in by doing:

autodoc_excludes = {
    # Applies to modules, classes, and anything else.
    '*': [
    'class': [
        # Useful for Django models.

        # Useful forms.

That’s just an example, but a useful one for Django users.

To install this extension, add the following to your

extensions = [


Adds some improvements when working with Django-based classes in autodocs, and when referencing Django documentation.

First, this will take localized strings using ugettext_lazy and turn them into actual strings, which is useful for forms and models.

Second, this adds linking for setting-based documentation, allowing custom settings (from django.conf.settings) to be documented and referenced, like so:

.. setting:: MY_SETTING

Settings go here.

And then to reference it: :setting:`MY_SETTING`.

To install this extension, add the following to your

extensions = [


Links source code for modules, classes, etc. to the correct line on GitHub. This prevents having to bundle the source code along with the documentation, and better ties everything together.

To use this, simply add the following to

from beanbag_docutils.sphinx.ext.github import github_linkcode_resolve

extensions = [

linkcode_resolve = github_linkcode_resolve


Provides references for HTTP codes, linking to the matching docs on Wikipedia.

To create a link, simply do:

This is :http:`404`.

If you want to use a different URL, you can add the following to

http_status_codes_url = 'http://mydomain/http/%s'

Where %s will be replaced by the HTTP code.

To install this extension, add the following to your

extensions = [


Copies all Retina versions of images (any with a @2x filename) into the build directory for the docs. This works well with scripts like retina.js.

To install this extension, add the following to your

extensions = [
Release History

Release History


This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
beanbag_docutils-1.0-py2.6.egg (24.7 kB) Copy SHA256 Checksum SHA256 2.6 Egg Jul 20, 2016
beanbag_docutils-1.0-py2.7.egg (24.6 kB) Copy SHA256 Checksum SHA256 2.7 Egg Jul 20, 2016
beanbag_docutils-1.0-py2-none-any.whl (15.6 kB) Copy SHA256 Checksum SHA256 py2 Wheel Jul 20, 2016
beanbag-docutils-1.0.tar.gz (9.7 kB) Copy SHA256 Checksum SHA256 Source Jul 20, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting