summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Remove unnecessary unicode prefixessongwenping2022-04-191-4/+4
| | | | Change-Id: Id6bb6fb85f9989746066ac042661cd4782f153c4
* Ussuri+ is python3 only and update python to python3dengzhaosen2021-05-063-3/+3
| | | | Change-Id: I504494cac13fb8b887df16fe6b93bf587ba35630
* Adding pre-commitHervé Beraud2020-09-081-4/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Introduced changes: - pre-commit config and rules. - Add pre-commit to pep8 gate, Flake8 is covered in the pre-commit hooks. - Applying fixes for pre-commit compliance in all code. Also commit hash will be used instead of version tags in pre-commit to prevend arbitrary code from running in developer's machines. pre-commit will be used to: - trailing whitespace; - Replaces or checks mixed line ending (mixed-line-ending); - Forbid files which have a UTF-8 byte-order marker (check-byte-order-marker); - Checks that non-binary executables have a proper shebang (check-executables-have-shebangs); - Check for files that contain merge conflict strings (check-merge-conflict); - Check for debugger imports and py37+ breakpoint() calls in python source (debug-statements); - Attempts to load all yaml files to verify syntax (check-yaml); - Run flake8 checks (flake8) (local) For further details about tests please refer to: https://github.com/pre-commit/pre-commit-hooks Change-Id: I4473e5e96419e4da9c8922d5832249da23c61acd Signed-off-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
* Fix pygments stylemelissaml2020-06-041-1/+1
| | | | | | | | New theme of docs respects pygments_style. more info: http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: I69a051117890860e3dc524a6361f5acb21820a02
* Merge "Add release notes links to doc index"Zuul2020-05-261-0/+6
|\
| * Add release notes links to doc indexHervé Beraud2020-04-161-0/+6
| | | | | | | | Change-Id: I2e1fa7512529c90a5ada0402483849837bd2e14d
* | Switch to newer openstackdocstheme and reno versionsAndreas Jaeger2020-05-182-6/+6
|/ | | | | | | | | | | | | | | | Switch to openstackdocstheme 2.2.0 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. openstackdocstheme renames some variables, so follow the renames. A couple of variables are also not needed anymore, remove them. Depends-On: https://review.opendev.org/728938 Change-Id: If23ebf2dcf6304d5ea50c5e427bfad217ce0d235
* Drop python 2.7 support and testing3.0.0pengyuesheng2020-01-301-2/+1
| | | | | | | | Ussuri Communtiy-wide goal: https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html Change-Id: Ie875138bd1b773f460698e1eacc9dab542318e30 Sem-Ver: api-break
* Bump the openstackdocstheme extension to 1.20pengyuesheng2019-12-192-6/+1
| | | | | | | | | | | | | | | | Some options are now automatically configured by the version 1.20: - project - html_last_updated_fmt - latex_engine - latex_elements - version - release Note that we don't actually drop 'project' since it's referenced elsewhere in the file and cleaning that up would be hassle. Change-Id: Ibe4add5a9391c3b3bc49206c9ac65721cedddf5a
* tox: Stop using 'python setup.py test'Stephen Finucane2019-12-061-0/+0
| | | | | | | pbr has deprecated this. Call stestr directly instead. Change-Id: I26628e4734c6d7a911fbe16ad753173a36fd8dab Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* tox: Keeping going with docscaoyuan2019-10-241-2/+2
| | | | | | | | | | | | Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name suggests, keeps the build running when it encounters non-fatal errors. This is exceptionally useful in avoiding a continuous edit-build loop when undertaking large doc reworks where multiple errors may be introduced. [1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045 Change-Id: I07690fb61001eb282d895fbbac4cd856defe6581
* Cap Bandit below 1.6.0 and update Sphinx requirementBen Nemec2019-05-131-1/+2
| | | | | | | | | | | | Bandit 1.6.0 accidentally changed how the exclusion list option is handled and breaks our use of it. Cap to the previous version until Bandit has fixed the problem. Sphinx 2.0 no longer works on python 2.7, so we need to start capping it there as well. Change-Id: Ib7f8df3fc5b83520b179d0a260c54e015c042b17 Reference: https://github.com/PyCQA/bandit/pull/489
* Replace git.openstack.org URLs with opendev.org URLsjacky062019-04-302-2/+2
| | | | Change-Id: Iaf18cea9ee9f1edfd1ef1a96a36de1569e399886
* Updated from global requirementsOpenStack Proposal Bot2018-03-151-1/+1
| | | | Change-Id: I1c0eedc5c321d2c847510a503f0a25e8382f1648
* Updated from global requirementsOpenStack Proposal Bot2018-01-241-1/+1
| | | | Change-Id: Ibfbb20b4e06815bc4ebd4dd7b3a60501fbf7cdcb
* Updated from global requirementsOpenStack Proposal Bot2018-01-181-1/+1
| | | | Change-Id: Ia41f791b8bde7b82d37f4de47d05d1b6ba4e6053
* Updated from global requirementsqueens-em2.20.0OpenStack Proposal Bot2018-01-041-0/+3
| | | | Change-Id: Idf473d822b830c808c6007bd6d82257fb7305e0a
* Follow the new PTI for document buildChangBo Guo(gcb)2017-12-191-0/+5
| | | | | | | | | | | | For compliance with the Project Testing Interface as described in: https://governance.openstack.org/tc/reference/project-testing-interface.html For more detials information, please refer to: http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html Change-Id: I9d23ea7b5731fb677b2b1a09cdec74a1101dcd2c
* Update the documentation link for doc migration2.18.1lingyongxu2017-08-281-1/+1
| | | | | | | This patch is proposed according to the Direction 10 of doc migration(https://etherpad.openstack.org/p/doc-migration-tracking). Change-Id: Ib60419cfcea0736f68960e3c94b83508e9f77ae1
* Fix URLs according to document migration2.17.0ChangBo Guo(gcb)2017-07-123-6/+6
| | | | Change-Id: I5e452dfc33c4bdf8f344f6e28ff1fd4a5e049476
* Cleanup document formattingAkihiro Motoki2017-07-052-5/+6
| | | | | | | | | | | - Previously the title of the top page was Team and repository tags. It was completely wrong. - Remove spaces before URLs in CONTRIBUTING.rst. In openstackdocstheme, we have vertical lines for quote blocks. Removing unnecessary spaces improves the visibility of rendered HTML. - Use appropriate highlighting style for code blocks. Change-Id: Ib0d2e4699767e7b52b015c328c366202b3e5ddc8
* rearrange the documentation to fit into the new standard layoutAkihiro Motoki2017-07-0514-11/+24
| | | | Change-Id: If9bd83a0ac47084e025899cee681feef06265406
* Switch from oslosphinx to openstackdocstheme2.16.0Van Hung Pham2017-06-291-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: I2ac1a1b9899b8bcb939fb287f09e7c69caca7fc9
* Optimize the link address2.15.0Van Hung Pham2017-06-135-9/+9
| | | | | | Update link address to ensure safety and preciseness Change-Id: Id193a5cefa3220036df69f5ca48aadc7ae02890b
* Add global_request_id to contextSean Dague2017-05-231-3/+6
| | | | | | | | | This provides the facility to have a global_request_id which is different from the service level request_id that we've been using. Includes basic testing. Change-Id: I1521188ae627fa2e7d35aa2ffffbcb620c527765
* Fix typosAtsushi SAKAI2016-08-232-3/+3
| | | | | | | respository => repository respresentative => representative Change-Id: I2f139cb9fb67ddd304be6d3df0b4a51baf43b783
* Improve Context docs with example syntaxRonald Bradford2016-01-297-3/+299
| | | | | | Added examples to explain how use Oslo Context with Oslo Log. Change-Id: I5b5d2ee152b305316b68c5b34d00f480c7daf5ba
* Documentation cleanupDoug Hellmann2014-11-199-28/+12
| | | | | | | | | Tidy up filenames, layout, and other minor issues with the documentation before our first release. bp/graduate-oslo-context Change-Id: Ib284bbdb50f868b232abc050311ddd5a9d9bde15
* Add ClearRequestContext fixtureDoug Hellmann2014-11-192-0/+8
| | | | | | | | | Add a fixture class for use in tests to provide a way to flush the cached RequestContext without exposing how that is stored. bp/graduate-oslo-context Change-Id: I27dd50a61d364e1698823629e2676c10ced50af3
* Generate better documentation for the moduleDavanum Srinivas2014-11-197-20/+40
| | | | Change-Id: Ibad798b09ac1227065173b3b1843cc3b6bfbaf80
* exported from oslo-incubator by graduate.shDavanum Srinivas2014-11-057-0/+132
View Lorry Controller Status