As it is required in [1] warning-is-error should be
set for doc building. This change sets the flag and
corrects the warnings.
[1]: http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
Change-Id: Ia93fd13645830cd8994ef283b72f31cb22cf3fe9
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Signed-off-by: csatari <gergely.csatari@nokia.com>
As part of the docs migration work[0] for Pike we need to switch to use
the openstackdocstheme.
[0]https://review.openstack.org/#/c/472275/
Change-Id: Ic0686fc1f1128d52c2ffb195d3cedb30de6f9c73
* After updating Sphinx to 1.6.2 Sphinx this extension got broken
and our Mistral "doc" CI job too
* We don't use Flask in the project anyway
Change-Id: I051ec26e155344684b69bad6a50f2162febbc928
When building packages if git is absent, then we should not set
html_last_updated_fmt. It can still be set via the -D switch
when building with sphinx-build.
Change-Id: I9a6aba18d40877f24c31d0b44cae4aca4b064655
Closes-Bug: #1552251
The pbr section in setup.cfg is not defined, so the module docs are not being
generated. This causes the 404 when clicking on the ‘Module Index’ link under
the 'Indices and Tables’ section in [0].
[0] http://docs.openstack.org/developer/mistral/
Change-Id: I337e9f6e78257a3e8e9222779dfcd600ba6cebd8
Closes-bug: #1558574
* initial documentation skeleton for further writing.
* Added man page to the conf (otherwise we get warning message)
* Added ChangeLog to .gitignore
* Changed html theme on readthedocs
Partially implements blueprint mistral-documentation
Change-Id: Iffc6e0e8b97d3599aa8c09b03011586354241abd
Setup structure and clean-up docs
Coming up next:
* TODO: migrate DSL specs from wiki
* TODO: setup autodocs to for REST v2
Change-Id: Ia15a65a2909bd71821c8a6e94b3f9470ee6145d5
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: If0b1cd2cdcd7184df4177850b63a113a6d5b5d67
Related-Bug: #1368910