With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Migrate
the setting from the old warnerrors one.
Fix problems found:
* Duplicate labels (rename wrong faq entries, rename unused drivers
entries)
* Add api/autoindex.rst as hidden to the index so that we do not get a
warning. The modindex includes the same content, so no need to show
this.
* Add releasenotes/index.rst, webapi/v1.rst, user-guide, and install-guide.rst
to hidden index since they're not listed in index on purpose, so sphinx
will not warn that they do not appear in a toc
* Add deploy/radosgw to index
* ignore app.add_directiv warning
* Fix reference to user-guide to use proper markup so that Sphinx knows
the user-guide is referenced.
Change-Id: I00d249229d4d31ba36d4393d60847fdb1513a744
We don't have tempest in our {test-}requirements.txt, which causes
docs build to complain about missing tempest.* modules, as we have
autodoc enabled, which imports all the modules it can find to get
their docstrings.
This change adds ironic_tempest_plugin modules to
autodoc_exclude_modules, and also adds it to exclude_patterns, so
that sphinx ignores ironic_tempest_plugin/* files too.
Also fixes a couple of warnings because of the incorrect formatting
of the LocalLinkConnectionType.validate docstring.
Closes-bug: #1609850
Change-Id: Id24e587b690b423e65dad55e70224426873e8d5d
In the sphinx config, mock out the nova imports we do for the
compute manager so the docs will build with fewer errors.
Exclude the alembic migration environment from autodoc.
Fix the remaining markup errors, which are now easier to spot
given the other fixes.
Note that this leaves one remaining warning, which is that the
generated API documentation isn't currently included in a
toctree. This is easy to fix but it would be good to discuss
whether/where to include it in the documentation hierarchy.
Closes-Bug: 1277282
Change-Id: Iee5fc3eeb95a09198d5234d0ea05e150ab26f16b
Add sequence diagrams generated by sphinxcontrib-seqdiag
along with the raw text that generated then, so that it can be
updated easily later.
The diagrams were created originally by Devananda van der Veen,
and used in OpenStack Summit YVR.
Ref)
* https://www.openstack.org/summit/vancouver-2015/summit-videos
/presentation/isn-and-039t-it-ironic-the-bare-metal-cloud
* http://devananda.github.io/talks/isnt-it-ironic.html
Change-Id: I47ff02c6cb4764c1740d0924668714ed205b3d9b
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
v1 API doc samples include XML:
http://docs.openstack.org/developer/ironic/webapi/v1.html
However, the Ironic API does not support XML.
This removes the XML documentation from the generated docs.
Change-Id: I0588709190eafa52a252d19a163dc42c36f2e061
Closes-Bug: #1311268
Use the new oslosphinx version of the OpenStack doc theme instead of
maintaining a copy of it in the Ironic repository.
Change-Id: I1d949d1e2734b10e38dea0067db9f3cfd7109c11
Correct the version string in setup.cfg for Icehouse.
Make ironic/version.py use PBR instead of the stale code that was there.
Make ironic/common/config.py properly set the version string so that
all CLI commands output it when "--version" is passed.
Remove openstack.common.version module which is no longer present in
oslo-incubator.
Closes-bug: #1294389
Change-Id: I9a7bfe5fc1b79934cf2467d6f8a6c16f41205dbf
Add the necessary bits for sphinxcontrib-pecanwsme
so that we can start auto-generating REST API docs.
Change-Id: I6ad61a5185462916865884dd1619465ef90aba0a
Closes-bug: 1251011
Some files still use trademark OpenStack LLC in header, which
should be changed to OpenStack Foundation.
Change-Id: I6ab820e61514c6004247d9b931976e03baf84ae0
Fixes-Bug: #1214176
Create doc/source/dev/ directory, and add several files that got
accidentaly ignored because they were under doc/source/api/.
Also move some files from doc/source into doc/source/dev to clean up the
base doc dir.
Change-Id: Ief9777216db82ec3be32b7a73e2d268a3a973ef8
Also turn on doc API autoindexing.
This depends on https://review.openstack.org/30520 landing in pbr and a
new point release being cut, as it uncovered a bug.
Change-Id: I8f4ffc4f7c54c7b207d6d52e74ccab020596e602
