summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Remove unnecessary unicode prefixessongwenping2022-04-191-4/+4
| | | | Change-Id: I4b8b982c9ef49595682744e022154be87f259d23
* Adding pre-commitHervé Beraud2020-09-031-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: I04e73b8a70d32fec3e6131526e0bed0be8599c28 Signed-off-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
* Merge "Add release notes links to doc index"Zuul2020-06-031-1/+11
|\
| * Add release notes links to doc indexHervé Beraud2020-04-161-1/+11
| | | | | | | | Change-Id: I25f156177ccabfb6fe99f808c3b5868affabafce
* | 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 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. Depends-On: https://review.opendev.org/728938 Change-Id: Ie162c8e72f4edec345c20de4517304cc14f7fe0d
* [ussuri][goal] Drop python 2.7 support and testing6.0.0Hervé Beraud2020-02-031-2/+1
| | | | | | | | | | | | | | OpenStack is dropping the py2.7 support in Ussuri cycle. Complete discussion & schedule can be found in - http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html - https://etherpad.openstack.org/p/drop-python2-support Ussuri Communtiy-wide goal: https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html Change-Id: I02784f635368ad7cc5ffde7cc8a4f4367143da98
* tox: Keeping going with docscaoyuan2019-11-031-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: I2858ce6bf73471328b92b52be1cdc18ab46254d9
* Bump the openstackdocstheme extension to 1.20pengyuesheng2019-10-122-3/+1
| | | | | | | | | | | | Some options are now automatically configured by the version 1.20: - project - html_last_updated_fmt - latex_engine - latex_elements - version - release. Change-Id: Ie89fa05774e224a9b8c05f0442fda7592df9aa5d
* Sync Sphinx requirementpengyuesheng2019-10-101-1/+2
| | | | | | | Sync sphinx dependency with global requirements. It caps python 2 since sphinx 2.0 no longer supports Python 2.7. Change-Id: I08fe97b5e15d7aae025f3d149c1242841d01ee5b
* Always close all passed in fds beyond sensible_fd_limit on launchDirk Mueller2019-03-231-2/+4
| | | | | | | | | | Change Idd98c183eca3e2df8648fc0f37d27fe9cc6d0563 stopped closing filedescriptors beyond the sensible_fd_limit. With this patch the previous behavior is restored. We can close the fds more efficiently by just iterating over /proc/self/fd on Linux and only change the rlimit/MAXFD setting when successful. Change-Id: I3b481ddd14ae2b948270d715aad157cf3996def7
* Run rootwrap with lower fd ulimit by defaultDirk Mueller2018-10-091-0/+8
| | | | | | | | | | | | | On Python 2.x, a subprocess.Popen() with close_fds=True will fork and then close filedescriptors range(3..os.sysconf("SC_OPEN_MAX")), which thanks to Kernel PTI (Kaiser patches) is significantly slower in 2018 when the range is very large. With a soft limit of 1048576, benchmark.py reports an overhead of ~ 400ms without this patch and 2ms with the patch applied. This patch adds a configuration option and sets a more sensible default of 1024 file descriptor limit by default. Closes-Bug: 1796267 Change-Id: Idd98c183eca3e2df8648fc0f37d27fe9cc6d0563
* Updated from global requirementsOpenStack Proposal Bot2018-03-151-2/+2
| | | | Change-Id: I49117280920792934351dbb86d9d7d886d4deefa
* Updated from global requirementsOpenStack Proposal Bot2018-01-181-1/+1
| | | | Change-Id: I344b5699294eca50d8a4bee93dc7ea403df873bd
* Updated from global requirementsqueens-em5.13.0OpenStack Proposal Bot2018-01-021-0/+3
| | | | Change-Id: Ibedd081f394ed3ac0fae1ece8ff937a3b6b79bc6
* Follow the new PTI for document buildSean McGinnis2017-12-291-0/+7
| | | | | | | | | | | | 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: Ifa689b590378f58d7abe2a52e8b92f5f32dc5196
* rearrange existing documentation to fit the new standard layout5.8.0Akihiro Motoki2017-07-087-15/+15
| | | | Change-Id: Ieded73a772471f6b2a32b489b4e3fc33a3daf33e
* Switch from oslosphinx to openstackdocsthemeAkihiro Motoki2017-07-081-2/+10
| | | | Change-Id: Iccb9d585485ecd0181c71c08de920f4836f0d774
* Remove unused use-syslog-rfc-format optionRonald Bradford2016-02-041-5/+0
| | | | | | | | Remove this option that appears ignored. For reference by similar name only, this option is marked as deprecated and to be removed from oslo.log in Mitaka. Refer to I9b77899fe437d359df2a15961866b194b564ca48. Change-Id: I9a97b53d829a9ca6b92ee4b545f616a3bc5b25be
* move usage instructions into main docsDoug Hellmann2015-09-253-8/+344
| | | | | | | | | | | | Pare down the readme by moving most of the usage instructions into the main documentation. Clean up the results so they render nicely. Remove the duplicate copy of those instructions by removing doc/source/readme.rst. Fix up the documentation and readme titles to make them consistent. Change-Id: I63f711bb28f3003d7b991d1526fd4b373b530143
* add pbr-generated release history to the documentationDoug Hellmann2015-09-242-0/+9
| | | | Change-Id: I8444a86b284739b5eb8e83cff09e7840fbe72452
* Clean up title on main doc pageDoug Hellmann2014-09-101-8/+5
| | | | | | | Make the title on the main documentation page consistent with the other projects. Change-Id: I8f15bfa8ace018f6e82e61a33fdbe20c96d8b8b9
* Initial cut of documentation for oslo.rootwrapDavanum Srinivas2014-09-106-0/+122
Closes-Bug: #1364141 Change-Id: If20de8767ff36b0a64c3b39f346d54a1ad6ca08f
View Lorry Controller Status