Documentation for our projects all live in subdirectories off of docs. For example, reviewboard/docs/manual/, rbtools/docs/rbtools/, etc. Each of these is managed by Sphinx, which should be installed automatically when configuring your development tree.

To build the documentation for a given module, run:

$ make html

If all went well, you can access the newly-built documentation by opening the desired page in _build/html/. You'll probably want to start with index.html.

<aside> 💡 When building the documentation, you'll notice that the styles won't match what you find on reviewboard.org.

We actually use a slightly different method to build and consume the documentation, rather than serving up those same generated HTML files.

Don't worry, as long as your documentation is consistent with the rest of the HTML, and looks correct, you're probably fine. We'll catch any issues during review.

</aside>