15 Commits

Author SHA1 Message Date
csatari
6c362ce53e Adding warning-is-error to doc building
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>
2017-07-13 10:11:15 +02:00
Sharat Sharma
532bfaf600 Switch from oslosphinx to openstackdocstheme
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
2017-07-05 05:10:00 +00:00
Renat Akhmerov
35db34c257 Remove 'sphinxcontrib.autohttp.flask' from sphinx config
* 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
2017-06-02 13:32:52 +07:00
Sharat Sharma
daf75c2852 Fix doc generation for python 3
The html_last_updated_fmt option is interpeted as a byte string in
python3, make it utf-8 string.

Change-Id: I7ba038ea1bca354681f973d68c06eb3c4bfa6e29
2017-05-23 14:38:54 +00:00
Sharat Sharma
3d6184e51a Fix doc build if git is absent
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
2017-01-31 17:18:36 +05:30
Rajiv Kumar
285beb6f84 Removed unnecessary utf-8 encoding
Change-Id: Ic2ac9598e1098a9b75172af0cab1db31bc2cf9e7
2017-01-11 02:58:04 +00:00
Sharat Sharma
a24941a943 Add timestamp at the bottom of every page
This patch adds the timestamp at the bottom of every page using the
given time format.

Change-Id: Ie54165cc181cd4c959e803438a2bf33b5ec02730
2016-11-26 02:40:07 +00:00
pawnesh.kumar
ca3e51b04f Fix PEP8 issue
Change-Id: I87bf05ff14b7128732b40bde5b562db2994508ae
2016-10-08 11:19:36 +05:30
Nina Goradia
fdb24bd697 module docs are not being generated
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
2016-03-21 17:27:14 -05:00
Nikolay Mahotkin
f0d95d99ea Mistral documentation: Initial commit
* 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
2015-08-07 12:06:53 +03:00
Dmitri Zimine
b8390eb84d Add documentation - part 3
Document REST v2 with autodocs

Change-Id: Ib43d2237ebb0f8ef9f8d18e70182d7cc5f2f0828
2014-10-16 20:45:39 -07:00
Dmitri Zimine
e328238c4c Add documentation - part 1
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
2014-10-05 12:56:37 -07:00
Christian Berendt
0aba87b682 Stop using intersphinx
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
2014-09-26 09:56:45 +02:00
Angus Salkeld
a7bf5cecc7 Add autogenerated API documentation
Change-Id: I859be6d47d58fee13875d02a7839864348829687
2014-05-28 21:28:24 +10:00
Renat Akhmerov
04903b823e Add .gitreview, setup.py and other infrastructure.
* .gitreview
* Disutils files
* tox configuration
* add .venv to ignore
* "mistral" package
* Sphinx documentation skeleton

Change-Id: I1d9aa5105b0dbc458665e9b16fd84826a18a36bf
2013-11-01 02:57:27 +07:00