Commit Graph

9 Commits

Author SHA1 Message Date
manchandavishal 797f882aa8 Update doc8 min version
doc8 0.6.1 supports python till version 3.4 [1] which doesn't
fit the current runtime requirements of wallaby [2] i.e.
python3.6 and python3.8. This patch updates the minimum
version of doc8 to 0.8.1 which supports python3.6 [3].

[1] https://pypi.org/project/doc8/0.6.0/
[2] https://governance.openstack.org/tc/reference/runtimes/wallaby.html
[3] https://pypi.org/project/doc8/

Change-Id: I7527a1a32ca7139b6a982c0d77a32674cd7cc6c5
2021-02-10 12:18:57 +00:00
manchandavishal f8658d9880 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* parallelizing building of documents

Update Sphinx version as well.

openstackdocstheme renames some variables, so follow the renames. A
couple of variables are also not needed anymore, remove them.

Set openstackdocs_pdf_link to link to PDF file.

Remove docs requirements from lower-constraints, they are not installed.

For more info. please refer [1].
[1] https://review.opendev.org/728938

Change-Id: I90d064e63baa5f067f38a881eb9a556dfb435e97
2020-05-19 15:26:39 +00:00
Oleksii Petrenko d6fe0170ee Change horizon test runner to pytest
Changes test invocation from `manage.py test` to `pytest`. Adds addtitional
test requirements like pytest, pytest-django, pytest-html. Adds
`pytest.mark` alongside django's test `tag`. Adds posibility to export test
results into xml and html formats.

Depends-On: https://review.opendev.org/#/c/712315/
Related-Bug: #1866666
Co-Authored-By: Ivan Kolodyazhny <e0ne@e0ne.info>
Change-Id: Idb6e63cd23ca2ba8ca56f36eb8b63069bd211944
2020-04-03 13:47:18 +03:00
Akihiro Motoki 3e54ba096f Complete "Drop Python 2.7 Support" goal
The goal definition in the TC repo [1] defines the completion criteria.
We have already completed 1, 2, 3 and partially 4 in [1].
This commit completes 4 (requirements.txt etc) and 5 (release note).

Python dependency in the installation guide is updated.
Django support plan in Ussuri is updated as well.
References to python 2.7 in the document are updated as well.

[1] https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html

Change-Id: I0383920e32e053e1611519be774fab8dec124ccc
2019-12-29 01:42:54 +09:00
Akihiro Motoki 205ebe0f47 tox: Move doc8 to docs related envs
Previously doc8 is run as part of pep8 tox env. This leads to some tricky
'deps' in pep8 which installs the docs dependencies. This can be fixed by
moving doc8 to the docs related tox envs (docs and releasenotes).

This also helps developers using devstack avoid hitting an error in
"manage.py compilemessages" in stack.sh. The error is caused by sphinx
installed under .tox directory (as compilemessages tries to compile all
message catalogs even under dot directories like .tox).
Developers sometimes change the horizon code under /opt/stack/horizon
and it is not surprising to run "tox -e pep8".
(I think it is more common compared to a chance to run "tox -e docs".)
Thus I believe it is reasonable to move doc8 to the docs env.

Change-Id: I6345ebbcd24afc358555e9be4b2ca700c4b33861
2019-10-02 09:28:11 +09:00
pengyuesheng b529f00937 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.

This will shows the version selector of the doc, too.

Change-Id: I38f0385a1fd676a4ba18259af7ad384af31ebe5a
2019-07-02 14:07:14 +08:00
pengyuesheng 11a12423be 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: Id66886127681d3987c0c9d6d233c35735700fdcb
2019-06-06 11:58:39 +08:00
manchandavishal ce00c5ab1c Update sphinx dependency
Sphinx 2.0 no longer works on python 2.7, so we need to start capping
it there as well.

Change-Id: I15172984b548bc2ad9ed6ab015da525ba6a49dd5
2019-05-13 19:06:04 +00:00
Akihiro Motoki eac3eae35a Follow the new PTI for document build
The detail is described in the following links:
https://governance.openstack.org/tc/reference/project-testing-interface.html
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

doc8 command is dropped from docs and releasenotes tox envs.
We run doc8 in pep8 tox env, so this hurts nothing.

Change-Id: I24271b527258b1de4cf26ca7efd625954eb834de
2018-03-25 02:14:40 +09:00