Summary

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

Review Request #8289 — Created July 15, 2016 and submitted July 19, 2016, 11:28 p.m.

Information

Owner

chipx86

Repository

beanbag-docutils

Branch

master

Bugs

Depends On

Commit

33f4342...

Reviewers

Groups

beanbag-docutils

People

Description

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.

Testing Done

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

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

Issues

Description	From	Last Updated
This is sorted very strangely.	david	July 18, 2016, 2:11 a.m.
Args/Returns?	david	July 18, 2016, 2:18 a.m.
Col: 1 E124 closing bracket does not match visual indentation	reviewbot	July 18, 2016, 2:18 a.m.

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

setup.py (Diff revision 1)

The issue has been resolved. Show all issues

Col: 1
 E124 closing bracket does not match visual indentation

.gitignore (Diff revision 1)
The issue has been resolved. Show all issues
```
This is sorted very strangely.
```
beanbag_docutils/sphinx/ext/autodoc_utils.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Args/Returns?
```

Change Summary:


Fixed up and added new docs.
Cleaned up the .gitignore to match some other projects' organization.
Fixed up a pyflakes warning for setup.py, and fixed the package name.

Commit:

3cd9d543f642fed9eb65f27d1683c10ee752c259

33f4342083216c401bfc48ae163a97f35acd68cb

Diff:

Revision 2 (+1021)

Show changes

	.gitignore
	.reviewboardrc
	README.rst
	setup.py
	beanbag_docutils/__init__.py
	beanbag_docutils/sphinx/__init__.py
	beanbag_docutils/sphinx/ext/__init__.py
	beanbag_docutils/sphinx/ext/autodoc_utils.py
	4 more

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

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to master (ffa60ae80016a1a55455c478cea653afcc4e7488)