Add a base foundation for Python codebase documentation.

Review Request #7363 — Created June 2, 2015 and submitted

Information

Review Board
release-2.5.x
06eed73...

Reviewers

This adds a new section to the Extending Review Board documentation that
links to auto-generated docs for the most interesting parts of the
codebase. These are the parts that are most likely to be useful to
extension writers and contributors looking to understand the main parts
of Review Board. Models, managers, registration functions, and so on.

The actual documentation files are auto-generated using Sphinx's
autosummary. These are not checked into source control. However, any new
module added to Review Board that requires documentation needs to go
into docs/manual/extending/coderef/index.rst.

Each module, class, and function in the docs link to the source code on
GitHub, taking into account the Git SHA and the branch/tag for the
current version.

Built the docs and went through the modules. The content was there. There's
still bits and pieces to fix up in the docs, which will be done in separate
changes.

Description From Last Updated

'VERSION' imported but unused

reviewbotreviewbot

Col: 1 E402 module level import not at top of file

reviewbotreviewbot

Col: 1 E402 module level import not at top of file

reviewbotreviewbot

'VERSION' imported but unused

reviewbotreviewbot

Col: 1 E402 module level import not at top of file

reviewbotreviewbot

Col: 1 E402 module level import not at top of file

reviewbotreviewbot

'reviewboard' imported but unused

reviewbotreviewbot

Col: 1 E402 module level import not at top of file

reviewbotreviewbot

'reviewboard' imported but unused

reviewbotreviewbot
reviewbot
  1. Tool: Pyflakes
    Processed Files:
        docs/manual/conf.py
        docs/manual/_ext/github_linkcode.py
        docs/manual/_ext/autodoc_utils.py
    
    Ignored Files:
        docs/manual/extending/index.rst
        docs/manual/extending/coderef/index.rst
        docs/manual/_templates/autosummary/module.rst
        .gitignore
    
    
    
    Tool: PEP8 Style Checker
    Processed Files:
        docs/manual/conf.py
        docs/manual/_ext/github_linkcode.py
        docs/manual/_ext/autodoc_utils.py
    
    Ignored Files:
        docs/manual/extending/index.rst
        docs/manual/extending/coderef/index.rst
        docs/manual/_templates/autosummary/module.rst
        .gitignore
    
    
  2. docs/manual/conf.py (Diff revision 1)
     
     
    Show all issues
     'VERSION' imported but unused
    
  3. docs/manual/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E402 module level import not at top of file
    
  4. docs/manual/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E402 module level import not at top of file
    
  5. 
      
chipx86
reviewbot
  1. Tool: Pyflakes
    Processed Files:
        docs/manual/conf.py
        docs/manual/_ext/github_linkcode.py
        reviewboard/__init__.py
        docs/manual/_ext/autodoc_utils.py
    
    Ignored Files:
        docs/manual/extending/index.rst
        docs/manual/extending/coderef/index.rst
        docs/manual/_templates/autosummary/module.rst
        .gitignore
    
    
    
    Tool: PEP8 Style Checker
    Processed Files:
        docs/manual/conf.py
        docs/manual/_ext/github_linkcode.py
        reviewboard/__init__.py
        docs/manual/_ext/autodoc_utils.py
    
    Ignored Files:
        docs/manual/extending/index.rst
        docs/manual/extending/coderef/index.rst
        docs/manual/_templates/autosummary/module.rst
        .gitignore
    
    
  2. docs/manual/conf.py (Diff revision 2)
     
     
    Show all issues
     'VERSION' imported but unused
    
  3. docs/manual/conf.py (Diff revision 2)
     
     
    Show all issues
    Col: 1
     E402 module level import not at top of file
    
  4. docs/manual/conf.py (Diff revision 2)
     
     
    Show all issues
    Col: 1
     E402 module level import not at top of file
    
  5. reviewboard/__init__.py (Diff revision 2)
     
     
    Show all issues
     'reviewboard' imported but unused
    
  6. 
      
chipx86
reviewbot
  1. Tool: Pyflakes
    Processed Files:
        docs/manual/conf.py
        docs/manual/_ext/github_linkcode.py
        reviewboard/__init__.py
        docs/manual/_ext/autodoc_utils.py
    
    Ignored Files:
        docs/manual/extending/index.rst
        docs/manual/extending/coderef/index.rst
        docs/manual/_templates/autosummary/module.rst
        .gitignore
    
    
    
    Tool: PEP8 Style Checker
    Processed Files:
        docs/manual/conf.py
        docs/manual/_ext/github_linkcode.py
        reviewboard/__init__.py
        docs/manual/_ext/autodoc_utils.py
    
    Ignored Files:
        docs/manual/extending/index.rst
        docs/manual/extending/coderef/index.rst
        docs/manual/_templates/autosummary/module.rst
        .gitignore
    
    
  2. docs/manual/conf.py (Diff revision 3)
     
     
    Show all issues
    Col: 1
     E402 module level import not at top of file
    
  3. reviewboard/__init__.py (Diff revision 3)
     
     
    Show all issues
     'reviewboard' imported but unused
    
  4. 
      
david
  1. Ship It!
  2. 
      
chipx86
Review request changed
Status:
Completed
Change Summary:
Pushed to release-2.5.x (ea25a14)