Fix the rest of the Sphinx documentation errors.

Review Request #7597 — Created Aug. 17, 2015 and submitted

Information

Djblets
release-0.9.x

Reviewers

This goes through and fixes all remaining documentation warnings for
syntax errors, broken references, conflicting types, files missing from
the Table of Contents, and more.

One change that's annoying but necessary to work around a Sphinx bug is
that we had to filter out any functions named "list" on classes. This
is because Sphinx will prioritize references to those instead of falling
back on the intersphinx mapping in the Python docs for the type. This
means our docs are incomplete, but in practice, the only time we name a
function "list" is when subclassing a Django template loader.

Added a build step to the Travis CI rules to ensure our docs are
generating without warnings or errors.

Docs built without any warnings or errors.

Checked that the "list" references pointed to the Python docs.

Description From Last Updated

Hrm. Shouldn't we just put this into the root .gitignore file?

daviddavid
david
  1. 
      
  2. docs/djblets/_static/.gitignore (Diff revision 1)
     
     
    Show all issues

    Hrm. Shouldn't we just put this into the root .gitignore file?

    1. We actually need the _static directory in order to prevent a warning from Sphinx (which turns into an error in Travis builds).

    2. Ahh. Got it.

  3. 
      
chipx86
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-0.9.x (e47a8e1)
Loading...