Add beanbag-docutils, a standardized collection of doc tools.

Review Request #8289 — Created July 15, 2016 and submitted

chipx86
beanbag-docutils
master
33f4342...
beanbag-docutils
This introduces a standardized set of Spinx extensions for use in our
documentation. We have several projects today that copy/paste the same
set of extensions, and maintaining these is increasingly hard. To help
keep this under control, they've been pulled out into this centralized
package.

Later, we'll be able to add additional tools or extensions to help with
our doc building processes. For instance, bundling newer (or forked)
releases of napolean.

The extensions in here are taken from Djblets, but have had some
enhancements made. Each has had documentation added to the source files,
and a couple of extensions have had updates:

* The github linking extension has been updated to be more generic,
  rather than hard-coding GitHub org/repo names and versioning logic.
* The autodoc_utils extension now supports a __autodoc_excludes__ list
  in modules.

This is all documented within the individual files and within the
README.rst.

Switched Djblets over to this and built the docs. Everything worked.

Tested that GitHub linking and module-level exclusions also worked.

Description From Last Updated

This is sorted very strangely.

daviddavid

Args/Returns?

daviddavid

Col: 1 E124 closing bracket does not match visual indentation

reviewbotreviewbot
reviewbot
  1. Tool: PEP8 Style Checker
    Processed Files:
        beanbag_docutils/sphinx/ext/http_role.py
        beanbag_docutils/__init__.py
        beanbag_docutils/sphinx/ext/django_utils.py
        beanbag_docutils/sphinx/ext/autodoc_utils.py
        setup.py
        beanbag_docutils/sphinx/ext/github.py
        beanbag_docutils/sphinx/ext/retina_images.py
    
    Ignored Files:
        beanbag_docutils/sphinx/ext/__init__.py
        beanbag_docutils/sphinx/__init__.py
        .reviewboardrc
        .gitignore
        README.rst
    
    
    
    Tool: Pyflakes
    Processed Files:
        beanbag_docutils/sphinx/ext/http_role.py
        beanbag_docutils/__init__.py
        beanbag_docutils/sphinx/ext/django_utils.py
        beanbag_docutils/sphinx/ext/autodoc_utils.py
        setup.py
        beanbag_docutils/sphinx/ext/github.py
        beanbag_docutils/sphinx/ext/retina_images.py
    
    Ignored Files:
        beanbag_docutils/sphinx/ext/__init__.py
        beanbag_docutils/sphinx/__init__.py
        .reviewboardrc
        .gitignore
        README.rst
    
    
  2. setup.py (Diff revision 1)
     
     
    Col: 1
     E124 closing bracket does not match visual indentation
    
  3. 
      
david
  1. 
      
  2. .gitignore (Diff revision 1)
     
     
     
     
     
     
     
     

    This is sorted very strangely.

  3. Args/Returns?

  4. 
      
chipx86
reviewbot
  1. Tool: Pyflakes
    Processed Files:
        beanbag_docutils/sphinx/ext/http_role.py
        beanbag_docutils/__init__.py
        beanbag_docutils/sphinx/ext/django_utils.py
        beanbag_docutils/sphinx/ext/autodoc_utils.py
        setup.py
        beanbag_docutils/sphinx/ext/github.py
        beanbag_docutils/sphinx/ext/retina_images.py
    
    Ignored Files:
        beanbag_docutils/sphinx/ext/__init__.py
        beanbag_docutils/sphinx/__init__.py
        .reviewboardrc
        .gitignore
        README.rst
    
    
    
    Tool: PEP8 Style Checker
    Processed Files:
        beanbag_docutils/sphinx/ext/http_role.py
        beanbag_docutils/__init__.py
        beanbag_docutils/sphinx/ext/django_utils.py
        beanbag_docutils/sphinx/ext/autodoc_utils.py
        setup.py
        beanbag_docutils/sphinx/ext/github.py
        beanbag_docutils/sphinx/ext/retina_images.py
    
    Ignored Files:
        beanbag_docutils/sphinx/ext/__init__.py
        beanbag_docutils/sphinx/__init__.py
        .reviewboardrc
        .gitignore
        README.rst
    
    
  2. 
      
david
  1. Ship It!
  2. 
      
chipx86
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to master (ffa60ae80016a1a55455c478cea653afcc4e7488)

Loading...