openstack
/
nova
Code Issues Proposed changes
nova/doc
History
Sean Mooney 33a56781f4 fix sphinx-lint errors in docs and add ci 
This change mainly fixes incorrect use of backticks
but also adress some other minor issues like unbalanced
backticks, incorrect spacing or missing _ in links.

This change add a tox target to run sphinx-lint
as well as adding it to the relevent tox envs to enforce
it in ci. pre-commit is leveraged to install and execute
sphinx-lint but it does not reqiure you to install the
hooks locally into your working dir.

Change-Id: Ib97b35c9014bc31876003cef4362c47a8a3a4e0e
 		2024-04-17 13:33:47 +01:00
..
api_samples Add support for showing requested az in output 2024-03-01 21:39:04 +05:30
api_schemas Add a proper schema version to network_data.json 2022-07-14 17:59:21 +02:00
ext Fix typos in nova docs 2022-09-23 09:09:37 +05:30
notification_samples Packed virtqueue support was added. 2023-11-29 16:06:33 +02:00
source fix sphinx-lint errors in docs and add ci 2024-04-17 13:33:47 +01:00
test docs: Revamp the security groups guide 2023-12-12 14:35:15 +00:00
README.rst Update api-ref location 2019-07-22 19:17:28 +02:00
dictionary.txt [codespell] fix final typos and enable ci 2023-12-15 12:32:42 +00:00
requirements.txt tox: Enable parallel docs build 2021-01-27 16:46:21 +00:00

README.rst

OpenStack Nova Documentation README

Both contributor developer documentation and REST API documentation are sourced here.

Contributor developer docs are built to: https://docs.openstack.org/nova/latest/

API guide docs are built to: https://docs.openstack.org/api-guide/compute/

For more details, see the "Building the Documentation" section of doc/source/contributor/development-environment.rst.