Add a base foundation for Python codebase documentation.
Review Request #7363 — Created June 2, 2015 and submitted
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 |
 reviewbot
|
|
|
Col: 1 E402 module level import not at top of file |
reviewbot
|
|
|
Col: 1 E402 module level import not at top of file |
reviewbot
|
|
|
'VERSION' imported but unused |
reviewbot
|
|
|
Col: 1 E402 module level import not at top of file |
reviewbot
|
|
|
Col: 1 E402 module level import not at top of file |
reviewbot
|
|
|
'reviewboard' imported but unused |
reviewbot
|
|
|
Col: 1 E402 module level import not at top of file |
reviewbot
|
|
|
'reviewboard' imported but unused |
reviewbot
|
- Change Summary:
-
- Linked to Django 1.6 and Python 2.7 docs.
- Consolidated the reviewboard.reviews.models docs into one page.
- Removed a page we didn't need.
- Commit:
-
1b0755ba1ff3e326fe0d1807ea3625b4930faaf08db328d0057634a65641e1e5ba1544bc5b900cb3
-
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 -
-
-
-
- Change Summary:
-
Fixed a ReviewBot complaint.
- Commit:
-
8db328d0057634a65641e1e5ba1544bc5b900cb306eed735a09febf038127aa5d04900ab9c114f16
-
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 -
-
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