11 Commits

Author SHA1 Message Date
Takashi Kajinami
1d155e48a2 Drop old excludes
These excludes were removed from the requirements repo[1] and are now
detected as errors.

[1] 314734e938f107cbd5ebcc7af4d9167c11347406

Change-Id: I0399c328ecbf74529658d0be0f88868049e6ba5f
2024-04-30 15:35:45 +09:00
Andreas Jaeger
b3e7c590f0 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.

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: I4ebb6e663471a7096bd9d0e1a90d8114d1875546
2020-05-21 09:43:55 +02:00
Andreas Jaeger
97db901658 [ussuri][goal] Finish dropping python 2.7 support
OpenStack is dropping the py2.7 support in ussuri cycle.

Complete discussion & schedule can be found in
- http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html
- https://etherpad.openstack.org/p/drop-python2-support

Ussuri Communtiy-wide goal:
https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html

This change cleans up:
* remove old requirements
* remove universal wheel building, we don't need this for py3
* cleanup setup.py
* tox.ini: move basepython around; remove install_command since the
  default is fine and constraints should be in deps; add
  ignore_basepython_conflict

Change-Id: Ife0a696ca62be21d3d93c5d8279a412578f62697
2020-02-06 18:58:12 +01:00
caoyuan
eb10545b37 tox: Keeping going with docs
1. Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name
suggests, keeps the build running when it encounters non-fatal errors.
This is exceptionally useful in avoiding a continuous edit-build loop
when undertaking large doc reworks where multiple errors may be
introduced.

2. Add whitelist_externals to fix the warning

[1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045

Change-Id: I47683ab1313981a8202afe6b3fe1779d40340452
2019-11-01 11:30:12 +08:00
Zuul
784863f12a Merge "Bump the openstackdocstheme extension to 1.20" 2019-09-25 15:50:37 +00:00
pengyuesheng
14f2678c48 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: Ie6b9bdc0cdb6939903920806334f71aa6133c12b
2019-08-01 09:43:50 +08:00
pengyuesheng
e08a81100f Blacklist sphinx 2.1.0 (autodoc bug)
See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details

Change-Id: Ifdfe8dc074f7e3bb4ea0df4cd78e95842fc322ab
2019-07-30 16:53:08 +08:00
gao.hanxiang
011fa22c42 Blacklist bandit 1.6.0 and cap Sphinx on Python2
There's a regression[0] in bandit 1.6.0 which causes bandit to stop
respecting excluded directories, and our tests throw a bunch of
violations. Blacklist this version, but allow newer versions as there is
already a pull request[1] to fix it, and I expect it will be included in
the next release.

Also fix the requirements job which was broken by
https://review.opendev.org/657890 adding a cap on Sphinx on Python 2.

[0] https://github.com/PyCQA/bandit/issues/488
[1] https://github.com/PyCQA/bandit/pull/489

Change-Id: Ieabcd4e8c5e5354125a63e89b9b60931c760858a
2019-05-14 16:50:24 -04:00
Zane Bitter
96e97013f1 Replace pbr autodoc with sphinxcontrib-apidoc
This fixes local building of the documentation using tox, and allows the
gate to stop relying on pbr and move completely to the new docs PTI.

http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

Change-Id: I6ef3e102f5a169262efbbaeec61452f0a2443fb4
Depends-On: https://review.openstack.org/560577
2018-04-11 16:35:01 -04:00
OpenStack Proposal Bot
170658867f Updated from global requirements
Change-Id: Icea60c74a8f6498ddcdd929fbc4ebfae0fcf021b
2018-03-17 08:29:48 +00:00
ricolin
e82bb7f330 Create doc/requirements.txt
For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html

Refer to:
http://lists.openstack.org/pipermail/openstack-dev/2017-November/124815.html

Change-Id: Ifdfdaacad8574fcfcac9c1b52b0bed6fed4f8411
2018-03-16 00:38:09 +08:00