Commit Graph

7 Commits

Author SHA1 Message Date
Hervé Beraud 749acf98d6 Add doc/requirements
We need to specify doc requirements in doc/requirements.txt
to avoid problems with the pip resolver [1] for the release team [2][3].
Removing specific doc requirements from test-requirements.txt.

The problem here is that this repos haven't doc/requirements.txt file
and by default in this case zuul will use the test-requirements.txt file
to pull requirements [4].

This requirements file contains extra requirements like flake8 that
collided with those allowed in our job environment and so the new pip
resolver fails to install these requirements and the job exits in error.

This project meet the conditions leading to the bug.

[1] http://lists.openstack.org/pipermail/release-job-failures/2021-January/001500.html
[2] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019611.html
[3] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019612.html
[4] https://opendev.org/zuul/zuul-jobs/src/branch/master/roles/ensure-sphinx/tasks/main.yaml#L36

Change-Id: I813c8d5c20b576911baea15fe9ae106e74500f3b
2021-01-07 17:32:29 +01:00
Andreas Jaeger 9232f14ea1 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.

Disable openstackdocs_auto_version to not auto-version the documents.

Disable openstackdocs_auto_name to use 'project' variable as name.

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.

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.

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

Change-Id: I3ef12cec64103a3fe2c101d05b211bc94c147d59
2020-06-01 16:27:45 +02:00
pengyuesheng de8893e91f 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: I43a278afd810498606c4ce5bc2ca50079380599e
2019-08-05 09:38:38 +08:00
jacky06 e4c84a9428 Replace git.openstack.org URLs with opendev.org URLs
Change-Id: I5bc44524d9f3487e3c73ed427afef641d6a17969
2019-04-26 10:03:46 +08:00
Nguyen Hai b0f5242c65 switch documentation job to new PTI
This is a mechanically generated patch to switch the documentation
jobs to use the new PTI versions of the jobs as part of the
python3-first goal.

See the python3-first goal document for details:
https://governance.openstack.org/tc/goals/stein/python3-first.html

Change-Id: I06200a75ace71bf88fe3449a21f5009b61295902
Story: #2002586
Task: #24347
2018-08-23 06:13:02 +00:00
Kien Nguyen c797709736 Fix Zun-tempest-plugin's documentation
Change-Id: Iebb6f1604a0b02919ad7419f42b4ecab47486021
2017-12-19 10:08:03 +07:00
Hongbin Lu efe304dca8 Apply cookiecutter to newly split project
This tempest plugin is being split out of the main zun 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 16:17:22 -04:00