Fix a handful of issues in our documentation.

Review Request #7592 — Created Aug. 16, 2015 and submitted

Information

Review Board
release-2.5.x

Reviewers

There were numerous bad references, anchor names, filenames, typos,
formatting, syntax errors, missing terms, conflicts, and other errors in
the documentation that have accumulated over the release.

This addresses these by fixing up the naming and references across the
codebase and addressing all the bad references I could find. New terms
and missing signal docstrings were added as well.

Along with this, I've fixed the release notes to include the current
year in the copyright.

Built the docs and saw a lot fewer errors.

Not eveything is fixed. Some are a bit hard to fix (seem to be Sphinx
autodoc bugs conflicting with Django's model support), and some
originate in Djblets. This is at least a good start, and are more
crucial for the 2.5 RC 1 release notes.

Description From Last Updated

Col: 80 E501 line too long (82 > 79 characters)

reviewbotreviewbot
reviewbot
  1. Tool: Pyflakes
    Processed Files:
        docs/releasenotes/conf.py
        reviewboard/extensions/hooks.py
        reviewboard/notifications/email.py
        docs/manual/conf.py
        reviewboard/reviews/ui/base.py
        reviewboard/reviews/signals.py
    
    Ignored Files:
        docs/manual/extending/extensions/hooks/review-reply-published-email-hook.rst
        docs/manual/extending/coderef/index.rst
        docs/manual/glossary.rst
        docs/manual/extending/extensions/hooks/email-hook.rst
        docs/manual/extending/extensions/hooks/review-request-closed-email-hook.rst
        docs/manual/extending/extensions/hooks/review-published-email-hook.rst
        docs/manual/extending/extensions/class.rst
        docs/manual/extending/extensions/hooks/review-request-published-email-hook.rst
    
    
    
    Tool: PEP8 Style Checker
    Processed Files:
        docs/releasenotes/conf.py
        reviewboard/extensions/hooks.py
        reviewboard/notifications/email.py
        docs/manual/conf.py
        reviewboard/reviews/ui/base.py
        reviewboard/reviews/signals.py
    
    Ignored Files:
        docs/manual/extending/extensions/hooks/review-reply-published-email-hook.rst
        docs/manual/extending/coderef/index.rst
        docs/manual/glossary.rst
        docs/manual/extending/extensions/hooks/email-hook.rst
        docs/manual/extending/extensions/hooks/review-request-closed-email-hook.rst
        docs/manual/extending/extensions/hooks/review-published-email-hook.rst
        docs/manual/extending/extensions/class.rst
        docs/manual/extending/extensions/hooks/review-request-published-email-hook.rst
    
    
  2. reviewboard/extensions/hooks.py (Diff revision 1)
     
     
    Show all issues
    Col: 80
     E501 line too long (82 > 79 characters)
    
  3. 
      
david
  1. Ship It!
  2. 
      
chipx86
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-2.5.x (959881d)
Loading...