Summary

Add the base foundation for Djblets codebase documentation.

Review Request #7368 — Created June 2, 2015 and submitted June 6, 2015, 7:25 p.m.

Information

Owner

chipx86

Repository

Djblets

Branch

release-0.9.x

Bugs

Depends On

Blocks

7387, 7371

Commit

0beeef1...

Reviewers

Groups

djblets

People

Description

This introduces a new set of docs for documenting all the utilities
provided by Djblets. Right now, we don't have any sort of high-level
overview, but we do have autodocs for all the modules people would want
to use.

Testing Done

Built the docs and looked through them. There's plenty to fix up still,
but this provides a pretty solid foundation.

Issues

Description	From	Last Updated
Col: 1 E402 module level import not at top of file	reviewbot	June 5, 2015, 5:12 p.m.
Col: 1 E402 module level import not at top of file	reviewbot	June 5, 2015, 5:12 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:12 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:12 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:12 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:12 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:12 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:12 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:12 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:12 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:12 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:12 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:12 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:12 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:12 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:12 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:12 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:13 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:13 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:13 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:13 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:13 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:13 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:13 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:13 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:13 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:13 p.m.
Col: 1 E265 block comment should start with '# '	reviewbot	June 5, 2015, 5:13 p.m.

Tool: Pyflakes
Processed Files:
    docs/djblets/_ext/github_linkcode.py
    docs/djblets/_ext/retina_images.py
    docs/djblets/_ext/httprole.py
    docs/djblets/conf.py
    docs/djblets/_ext/autodoc_utils.py
    djblets/__init__.py

Ignored Files:
    docs/djblets/contents.rst
    docs/djblets/Makefile
    .gitignore
    docs/djblets/_templates/autosummary/module.rst
    docs/djblets/coderef/index.rst
    docs/djblets/index.rst



Tool: PEP8 Style Checker
Processed Files:
    docs/djblets/_ext/github_linkcode.py
    docs/djblets/_ext/retina_images.py
    docs/djblets/_ext/httprole.py
    docs/djblets/conf.py
    docs/djblets/_ext/autodoc_utils.py
    djblets/__init__.py

Ignored Files:
    docs/djblets/contents.rst
    docs/djblets/Makefile
    .gitignore
    docs/djblets/_templates/autosummary/module.rst
    docs/djblets/coderef/index.rst
    docs/djblets/index.rst

docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E402 module level import not at top of file
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E402 module level import not at top of file
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```
docs/djblets/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 1
 E265 block comment should start with '# '
```

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to release-0.9.x (96e2822)

docs/djblets/conf.py (Diff revision 1)

docs/djblets/conf.py (Diff revision 1)

docs/djblets/conf.py (Diff revision 1)

docs/djblets/conf.py (Diff revision 1)