Commit Graph

11 Commits

Author SHA1 Message Date
Dr. Jens Harbott 62568cf307 Fix requirements for doc build
The doc build needs WebTest, which used to be imported as a transitive
requirement via pecan, but the latest release of pecan dropped this
dependency. So make this requirement explicit.

Change-Id: Ib3f3318440c79909090616b9d480b8dbf55e7b81
2022-07-05 10:26:08 +02:00
Rodolfo Alonso Hernandez a660f77d38 Remove "mitogen" library installation from "docs" job
Since pyroute 0.6.2, this dependency is not needed anymore. The
pyroute version is bumped both in requirements and doc/requirements.

This patch bumps the pyroute2 version to 0.6.4 (newest version
provided in upper-requirements).

Change-Id: I627e902e32fe59c6829c3bc92af19abff4b70f9a
Related-Bug: #1928913
2021-06-07 12:39:28 +00:00
Rodolfo Alonso Hernandez 9e6b7a2284 Install "pyroute2" as a doc job depedency
By adding this library to the doc requirements file, tox will install
it limiting the upper version according to
"requirements/upper-constraints.txt".

"pyroute2" is called in tox doc job as mentioned in [1]. Since version
0.6.0, the library structure changed. To keep backwards compatibility,
all modules are imported from the main namespace. As reported in the
referred bug, the library "mitogen" must be installed first.

In stable releases that use older "pyroute2" versions, this library is
not needed but this patch should enforce the upper library version.

Related-Bug: #1928913

[1]2a4074918c/doc/source/conf.py (L33-L40)

Change-Id: I0cf458f4532d313e593a943653e8310b93ac1e9c
2021-05-19 14:31:31 +00:00
Andreas Jaeger d46228b0b3 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.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Set openstackdocs_auto_name to use 'project' 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: I780eea00c9c47f52dcc7928546fd22dec5d145b4
2020-05-20 22:06:45 +02:00
Mike Perez 3ac866950f Replace support matrix ext with common library
The code to generate a support matrix has been pulled into a common
library. Using this instead of duplicating code in various projects that
need it.

Change-Id: I72d722af659a35266a9a391f4a73035b2bd3dabd
Co-Authored-By: Stephen Finucane <stephenfin@redhat.com>
Co-Authored-By: Slawek Kaplonski <skaplons@redhat.com>
2020-01-17 11:10:17 +01:00
Brian Haley ed26c606c1 Add a tox requirements target
In some other repos you can run 'tox -e requirements' and
run the requirements checks, which is useful when adding
or changing requirements.  Add it to tox.ini and fix a
python2 warning it noticed as well.

Change-Id: I8caa7f755d1276ffe581583a1ea61bb5f0473924
2019-12-11 13:21:42 -05:00
pengyuesheng 5be70fae01 Blacklist sphinx 2.1.0 (autodoc bug)
See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details
Depend-On: https://review.opendev.org/#/c/663060/

Change-Id: I094854a51d0bd3c0fb1893e1ebd806b737a0a16b
2019-07-01 14:51:21 +08:00
翟小君 43d5530405 Bump openstackdocstheme to 1.30.0
...to pick up many improvements, including the return of table borders.

Change-Id: I8853ce602dfaf9e163b77db7cfa0c9d3f2d3fbd7
2019-06-06 09:34:28 +08:00
Harald Jensås 8addd662b5 Update sphinx requirements
Requirement check is failing on sphinx.

http://logs.openstack.org/87/658787/3/check/requirements-check/ce69c94/job-output.txt.gz#_2019-05-13_18_52_15_176388

Change-Id: I7b02523b7135b2f2977c1f5ac16cb79fd41b8ef5
2019-05-14 14:52:15 +02:00
Nate Johnston fab6bcbdcd Fix build-openstack-sphinx-docs test job
The build-openstack-sphinx-docs is currently failing with the error
"ImportError: No module named oslotest" based on an import in
neutron/tests/functional/db/test_migrations.py.  Add oslotest to
the doc requirements.

Change-Id: Ibb2b8b246ad685e2e7e2bb8d3ac1d4c7c3a981b7
2018-05-31 12:42:00 +00:00
Nguyen Hai 0556a2ab73 Follow the new PTI for document build
For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Remove the '[build_sphinx]' as described in:
http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

Change-Id: Id3d7065028b4c0831e6b5c2363b19626734817a3
2018-03-24 13:23:33 +09:00