Commit Graph

8 Commits

Author SHA1 Message Date
Brian Haley 969d66e149 Update the contributor information
Some of the links and information were outdated here, update
and point to Neutron tree for installation and usage.

TrivialFix

Change-Id: Ia913a976dc2f60eb28548b2f099d924e160df2cf
2023-11-15 09:58:15 -05:00
Elod Illes f2e985e8fd Add test documentation for docs tox target
Enable sphinx to generate documentation from docstrings by running
'tox -e docs'.

Change-Id: I5996e5f07493f69f14172b4bb0535852e89d5456
2023-11-08 15:52:37 +01:00
LiZekun 8ad510e60b Remove unicode literal from code
All strings are considered as unicode literal string from Python 3.

This patch drops the explicit unicode literal (u'...')
appearances from the unicode strings.

Change-Id: I71621b95c87e7c10e86d8341173967235912053d
2022-06-06 11:37:59 +00:00
elajkat 2903040070 Add doc/requirements
We need to specify doc requirements in doc/requirements.txt
to avoid problems with the pip resolver for the release team.
Removed specific doc requirements from test-requirements.txt

Change-Id: Ia88848fd9c4ce35d396bc186ae3894a1d5865db9
2021-01-05 12:52:45 +01:00
Andreas Jaeger 7dc2857705 Switch to newer openstackdocstheme and reno versions
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.

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.

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.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I02b83b2d2ffa7e007f8150176ac881a8b6a53495
2020-06-02 00:19:08 +00:00
pengyuesheng 88ff7434af Bump the openstackdocstheme extension to 1.20
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.

Change-Id: I2e12b3da4686bf9f18d55fbb629d8a4525f3bc8d
2019-07-26 11:34:09 +08:00
Chandan Kumar 17f5380b29 Fix documentation build
The contributing.rst file was referencing a non-existing path, and
index.rst referenced a non-existing usage.rst file.

Added build-openstack-sphinx-docs job to test doc changes

Change-Id: Ie08e6b1a49a69fedb0fe1ddcf0225d0018aa65b4
2018-03-14 18:16:36 +05:30
Chandan Kumar 5e6198734b Apply cookiecutter to newly split project
This tempest plugin is being split out of the main neutron project in
accordance with Queens goal "Split Tempest Plugins into Separate
Repos/Projects"[1]. This patch applies the standard boilerplate files
for OpenStack projects so that it can stand on its own.

[1] https://governance.openstack.org/tc/goals/queens/split-tempest-plugins.html
2017-09-07 22:23:55 +05:30