Fix a handful of failures and regressions in our docs.

Review Request #9238 - Created Oct. 3, 2017 and submitted

Christian Hammond
Review Board
release-3.0.x
019dca4...
reviewboard

The documentation no longer built, due to a series of missing files and
fixtures, incorrect metadata, and bad references.

This change fixes all that by:

  • Adding fixtures for issue verification state, OAuth2 apps/tokens, and
    user-based file attachments
  • Adding missing API error and resource doc files
  • Adding missing terms to the glossary
  • Fixing metadata issues in new API resources
  • Fixing the fixture dump script to include the new apps
  • Fixing syntax errors in docstrings
  • Fixing anchor names

It also fixes some bad filenames generated for the OAuth2 resources. The
uncamelcasing tried using "o-auth" instead of "oauth" in the filenames.
To fix this, support has been added for allowing names to be remapped as
needed in the config file.

Built the docs. There were still a couple of errors, but they're bigger
tasks that we've lived with until now. All the major ones preventing doc
building or cross-referencing are now gone.

  • 0
  • 0
  • 2
  • 0
  • 2
Description From Last Updated
Barret Rennie
  1. Ship It!
  2. 
      
Christian Hammond
David Trowbridge
  1. 
      
  2. docs/manual/_ext/webapidocs.py (Diff revision 2)
     
     
     

    This is basically a no-op and can be removed entirely.

    1. Yeah, it was here for some debugging before. I'll remove it.

  3. docs/manual/scripts/dumpdata.sh (Diff revision 2)
     
     
     

    It would be nice to put one per line now.

  4. 
      
Christian Hammond
David Trowbridge
  1. Ship It!
  2. 
      
Christian Hammond
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-3.0.x (aec6fdf)
Loading...