Add the base foundation for Djblets codebase documentation.

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

Information

Djblets
release-0.9.x
0beeef1...

Reviewers

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.

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

Description From Last Updated

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

reviewbotreviewbot

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

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot

Col: 1 E265 block comment should start with '# '

reviewbotreviewbot
reviewbot
  1. 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
    
    
  2. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E402 module level import not at top of file
    
  3. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E402 module level import not at top of file
    
  4. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  5. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  6. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  7. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  8. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  9. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  10. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  11. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  12. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  13. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  14. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  15. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  16. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  17. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  18. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  19. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  20. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  21. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  22. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  23. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  24. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  25. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  26. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  27. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  28. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  29. docs/djblets/conf.py (Diff revision 1)
     
     
    Show all issues
    Col: 1
     E265 block comment should start with '# '
    
  30. 
      
david
  1. Ship It!
  2. 
      
chipx86
Review request changed
Status:
Completed
Change Summary:
Pushed to release-0.9.x (96e2822)