summaryrefslogtreecommitdiff
path: root/doc/source/conf.py
Commit message (Collapse)AuthorAgeFilesLines
* Remove unicode-related Python2-only codeCyril Roelandt2022-11-141-4/+4
| | | | | | | | This commit: - removes the old "u" prefix from all strings - removes the unicode_key_value_to_string function Change-Id: I1da347e31e828fd2359f0935a4da47257116d4cb
* Switch to newer openstackdocstheme and reno versions3.2.0Andreas Jaeger2020-05-221-9/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. Remove docs requirements from lower-constraints, they are not needed during install or test but only for docs building. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: Ie4aec288c74b9bd8d8d117f4bc2e0282cea4db90
* Bump openstackdocstheme to 1.20.0翟小君2019-07-021-1/+0
| | | | | | | | | | | | Some options are now automatically configured by the version 1.20: - project - html_last_updated_fmt - latex_engine - latex_elements - version - release. Change-Id: I2577ca452a014402f1377474457095176d422b42
* Follow the new PTI for document buildNguyen Hai2018-04-121-1/+9
| | | | | | | | | | | | | - Follow new PTI for docs build - Add sphinxcontrib.apidoc to replace pbr autodoc REF: https://governance.openstack.org/tc/reference/project-testing-interface.html http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html Co-Authored-By: Nguyen Hai <nguyentrihai93@gmail.com> Change-Id: Id16a5eaa57bc0d96332849abfb62898e6766ef86
* Fix man page buildJavier Pena2017-07-041-1/+1
| | | | | | | | | | https://review.openstack.org/474775 moved glance.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: I2c37755553d1265fb9fb069067c4468853f395b7
* use openstackdocstheme html contextDoug Hellmann2017-06-281-1/+11
| | | | | | | | | | | Set some of the new config values and enable openstackdocstheme as an extension so it will inject values into the page context as it writes each documentation page. This ensures the pages link to the right bug tracker, etc. Change-Id: I316bd585f91064af4d1d1e7b834986619fc3a2d3 Depends-On: Icf3a40ed104cfd828f532f6f2b112ed02f996ff5 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* switch to openstackdocsthemeDoug Hellmann2017-06-281-1/+12
| | | | | Change-Id: Id687e3405d8afe0db201eb648941cc51bb9f741e Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* move existing content into the new standard structureDoug Hellmann2017-06-281-43/+0
| | | | | | | | | | | | | | | | This patch rearranges and reformats existing content. It replaces the home-grown autodoc feature with the one built into pbr, for consistency with other OpenStack projects. It depends on the doc-migration spec and a pbr feature to allow us to specify where the autodoc content should go in the source tree during the build. Change-Id: I8d2bb11b5ef3e46fcd22c8bed8f84060d8ab6f03 Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Depends-On: I2bd5652bb59cbd9c939931ba2e7db1b37d2b30bb Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* doc: Remove cruft from conf.pyStephen Finucane2017-04-201-25/+6
| | | | Change-Id: I1bbb2d490f0415e4062da520e6fb09e6db477aa0
* Generate API documentationIan Wienand2015-02-161-0/+57
| | | | | | | | | | | | | | | | As a new user I found navigating the documentation difficult. The flow was a bit unclear and searches bring up old versions of API references that aren't included in the current documentation. This - provides an introduction to the tools similar to other projects - generates API references for the v1 and v2 client - fixes some minor docstring issues - adds doc/* to pep8 tests to check the conf.py The API generation code is cribbed from python-novaclient Change-Id: I65772127679d7afd5e7e48ca7872366b01382f21
* Stop using intersphinxAndreas Jaeger2014-09-131-4/+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: I4a59f194bd0fc8c86c6d3c6b8cadb839a5158935
* Remove unused importsWu Wenxiang2014-01-011-1/+0
| | | | | | | Remove unused imports in doc/source/conf.py Change-Id: Ie5f914ca21ee4229686deec01acd788acd4946b7 Closes-Bug: #1265265
* Provide glance CLI man page.Jakub Ruzicka2013-07-251-3/+14
| | | | | | | | | | Provide basic but hopefully useful man page. Also update OpenStack LCC to OpenStack Foundation in docs. Resolves: bug 1193111 Implements blueprint: clients-man-pages Change-Id: I9502b3d5ca75149d747d523934a6401e435924b7
* Fix PEP8 issues.lrqrun2012-09-101-10/+15
| | | | | | Fix some pep8 issues in doc/source/conf.py make the code looks pretty. Change-Id: I44f8152de76ae217d1dd81c9c0c1b1e075ec8792
* Add initial docs.0.1.0Monty Taylor2012-06-141-0/+60
Change-Id: I1f8407597105a914945c932ff55945c8005e273c
View Lorry Controller Status