The Sphinx autodoc extension now wants testtools installed, so docs
builds are breaking. The value of autodoc'd unit tests is basically
nil, since contributors should be able to read the source code
anyway, so let's just get rid of this section.
Change-Id: Iec379fa0680c7552fa2a5ad77b4f23748f6afceb
Since we have release notes for bindep, we should publish them
alongside our documentation. Also update to more modern patterns for
invoking Sphinx, splitting documentation build requirements to their
own file. Drop use of the openstackdocstheme and just rely on the
default Alibaster theme like other OpenDev tools do. Remove a few
other OpenStackisms in the Sphinx configuration too, and drop the
autogenerated date included in the copyright value (not only is it
unnecessary, it's bad practice from a rebuildability standpoint, and
inaccurate since the date docs were built is not necessarily the
date the content was written).
Change-Id: I84ab856dc92d0546653fe7ca7c4e9683835c9c4a
- assure we can all bindep as a module (python -m bindep)
- add test the assures output is the same regardless how is called
- include argparse fix which needs to know executable name when
called as modules.
- enables use of bindep without needing to have it in PATH
Change-Id: Ib2aac359e2f23cb0ac7857835905e0a02e90888d
* Use openstackdocstheme instead of obsolete oslosphinx
* Update requirements to current versions
* Use sphinx-build instead of pbr specific commands
* Fix wrong indend to avoid sphinx warning
Change-Id: I5aff91ec45466f25b825b1729561976db69eb188
Add Python API and test indices to rendered documentation. This is
rudimentary for now, but will get better as useful docstrings are
added to the Python source.
Change-Id: I723ee931e3c219ce08c3d24f79e862e8b304733e
We don't currently use sphinx.ext.autodoc as most of the source code
is missing docstrings anyway. Remove it so that we'll stop creating
a broken link to py-modules.html when rendering documentation. This
can be reverted later when we're ready to add source documentation
to the project.
Change-Id: I6a2c599f319859985812fe61ad5b3d7aea196e05
Add a NEWS.rst listing backward-incompatible behavior changes
between the latest 1.0.0 and upcoming 2.0.0 releases.
Change-Id: Ic9ab861bc676383965ea0b18c5922974dd8eacc7
This is initial boilerplate bringing in the existing basic project
documents so that Sphinx can index and build them.
Change-Id: I8caa72164ac897ea57a38c39f11d471b0bb3596c
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)
This also removes the requirement for internet access during docs build.
This can cause docs jobs to fail if the project errors out on
warnings.
Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
Jeremy Stanley