summaryrefslogtreecommitdiff
path: root/doc/source/conf.py
Commit message (Collapse)AuthorAgeFilesLines
* Bump openstackdocstheme to 1.20.0翟小君2019-07-041-11/+6
| | | | | | | | | | | | Some options are now automatically configured by the version 1.20: - project - html_last_updated_fmt - latex_engine - latex_elements - version - release. Change-Id: Icbfa21da1e83f745a98822a2f33c4ebc8d11fd0c
* Fix doc build errorEric Harney2018-12-141-0/+2
| | | | | | | | | | | | Doc build keeps failing w/ Recursion error: maximum recursion depth exceeded while pickling an object Sphinx recommends bumping up the recursion limit to get around this, and it appears to work. Change-Id: If0a78f9af2e4ddd5fd88c44757642355b3a5bf2e
* doc: Remove cruft from conf.pyStephen Finucane2017-08-221-136/+6
| | | | Change-Id: I0c0c77c25d3c96dd3c6a2a01be4f196c02e71dd6
* Use Sphinx 1.5 warning-is-errorStephen Finucane2017-08-221-5/+0
| | | | | | | | 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. Change-Id: Ifd411ead74497a43ab22c57090ece2e1c7cfddb5
* Fix man page buildThomas Bechtold2017-07-291-1/+1
| | | | | | | | | | Ia3b5ee2b6aaf17781d3de7546a9477f1c928092f moved cinder.rst from the doc/source/man directory into doc/source/cli, so we need to adjust the path in conf.py to avoid issues when running: python setup.py build_sphinx -b man Change-Id: I32ca20e0e184b11c68c9b81a9ff3d1247330ade4
* Switch from oslosphinx to openstackdocsthemeVan Hung Pham2017-07-141-2/+12
| | | | | | | | | 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: Ie5930c73c748bb308940606fced8f84eecdecdc8
* Fix some PEP8 issues and Openstack Licensingpawnesh.kumar2016-10-141-37/+51
| | | | | | | [H102 H103] Contributed Source code should be licensed under the Apache 2.0 license. Change-Id: I7d69bd9c8138d9ea5306c2fda56de875e33c544e
* Add reno for release notes managementSean McGinnis2015-12-131-1/+4
| | | | | | | | | | Adopt reno for release notes like we have done for cinder. One difference for the client is we will not be backporting to Liberty per recommendation here [1]. [1] http://lists.openstack.org/pipermail/openstack-dev/2015-November/080694.html Change-Id: Icb2520cfa249d104674eb42b5ac93a50a6ce34b4
* Stop using intersphinxAndreas Jaeger2014-09-131-5/+1
| | | | | | | | | | | | | | 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
* Update theme for docsSteve Martinelli2014-07-241-2/+2
| | | | | | | | The current developer docs theme used is out of sync with the other openstack projects. This patch will update the docs to provide a more consistent look and feel when using developer docs Change-Id: I9fd11b61d4404ba2627569074dc86ee0ddf0f96a
* Provide cinder CLI man page.Jakub Ruzicka2013-08-051-4/+9
| | | | | | | | | | | | | | Provide basic but hopefully useful man page. shell.rst was merged into and replaced by the man page in HTML docs. pbr is used to determine version. Docs copyright was changed to more accurate "OpenStack Contributors". Fixes: bug 1206968 Implements: blueprint clients-man-pages Change-Id: Iedd7b4b161ced564833fd9433762b87a4c1a374d
* python3: Fix unicode stringsChuck Short2013-06-131-4/+4
| | | | | | | | | Python3 enforces the distinction between byte strings and text strings more rigorously than python2. So use six.text_type where approiate. Change-Id: I46b3f5fe1f990fc1b7a3ee32904d608b070fc4c3 Signed-off-by: Chuck Short <chuck.short@canonical.com>
* Fix PEP8 issues.lrqrun2012-08-291-9/+13
| | | | | | Fix some pep8 issues in doc/source/conf.py make the code looks pretty. Change-Id: I4062904dfebf62dddb7ca2cb7b6c547c5026eb54
* Move docs to doc.Clark Boylan2012-06-151-0/+201
To better facilitate the building and publishing of sphinx documentation by Jenkins we are moving all openstack projects with sphinx documentation to a common doc tree structure. Documentation goes in project/doc and build results go in project/doc/build. Change-Id: I3ae14ac735d9b4c0b534eac9a9c142f8ccaac1b9