Commit Graph

5 Commits

Author SHA1 Message Date
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
Andreas Jaeger dbe6321537 Update api-ref location
The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.

Note that Neutron publishes to api-ref/network, not networking anymore.

Note that redirects will be set up as well but let's point now to the
new location.

For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html

Change-Id: Id2cf3aa252df6db46575b5988e4937ecfc6792bb
2019-07-22 19:17:28 +02:00
Stephen Finucane 88c31c8077 doc: Further cleanup of doc contributor guide
Change-Id: I03f00876fd8a51af487b18b8eb3f53454f81f0a2
2017-09-15 10:44:27 -06:00
Ken'ichi Ohmichi 547725946b Fix contributor documentation
There are some small comments on the review of
Ib2b49f70c55311195535a5ef250ff555e227fa0a
This is a follow-up for these comments.

Change-Id: I1d2d95a0864578161a34084db31eb460e895c1ec
2017-08-16 10:20:12 -07:00
Sean Dague 54529f03c9 Add documentation for documentation contributions
Missing from our contributor guides is documentation guidelines,
starting a page there for now especially as there are a couple of
things that emerged in the great pike import that would be good to
write down.

Part of bp: doc-migration

Change-Id: Ib2b49f70c55311195535a5ef250ff555e227fa0a
2017-08-09 11:20:12 -04:00