Commit Graph

21 Commits

Author SHA1 Message Date
Hervé Beraud 8036700154 Add doc/requirements
Removing specific doc requirements from test-requirements.txt and move
them to a dedicated place.

Indeed, we need to specify doc requirements in doc/requirements.txt
to avoid problems with the pip resolver [1] for the release team [2][3].

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: Ibf838f01d935763ff1e0d19f10340c8ee360784c
2021-01-07 11:54:17 +01:00
Andreas Jaeger e5ae79051f Switch to newer openstackdocstheme version
Switch to openstackdocstheme 2.2.1 version. Using
this version 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: Id7a2401cd31c0b05812a76d2cc5f1e6a014cb510
2020-05-31 17:53:48 +02:00
Ghanshyam Mann 601b450cf9 Fix hacking min version to 3.0.1
flake8 new release 3.8.0 added new checks and gate pep8
job start failing. hacking 3.0.1 fix the pinning of flake8 to
avoid bringing in a new version with new checks.

Though it is fixed in latest hacking but 2.0 and 3.0 has cap for
flake8 as <4.0.0 which mean flake8 new version 3.9.0 can also
break the pep8 job if new check are added.

To avoid similar gate break in future, we need to bump the hacking min
version.

Also removing the hacking and other related dep from lower-constraints file
as theose are blacklisted requirements and does not need to be present
there.

- http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014828.html

Change-Id: I475765d76453590c47de84809fd51433d4577c76
2020-05-15 11:42:04 -05:00
Andreas Jaeger c127687d3d Cleanup py27 support
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from setup.py
- Remove obsolete sections from setup.cfg
- Update requirements, no need for python_version anymore
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version
- Remove install_command from tox.ini, the default is fine;
  move contraints into deps
- Move python3 into base tox environment.

Change-Id: Ibd243ce5be8415147c24f596b4059ec3fb68a89c
2020-04-11 15:39:10 +02:00
Andreas Jaeger fd861534ef Update hacking for Python3
The repo is Python 3 now, so update hacking to version 3.0 which
supports Python 3.

Change-Id: Ia544cd6c50fa458b14ca02648338aaecb17b0de9
2020-04-01 13:32:53 +02:00
jacky06 67b317ce82 Sync Sphinx requirement
1. Sync sphinx dependency with global requirements. It caps python 2 since
sphinx 2.0 no longer supports Python 2.7.
2. Update the UPPER_CONSTRAINTS_FILE for tox[1]
3. Update some URLs to latest

[1]: http://lists.openstack.org/pipermail/openstack-discuss/2019-May/006478.html

Change-Id: Ibe8c402c2817c31748e6a4b8344024a276609260
2019-06-25 14:36:09 +08:00
OpenStack Proposal Bot 240340e953 Updated from global requirements
Change-Id: I0c7662f8460a2acd9e2e0213078730475e05fa1e
2018-03-15 07:08:40 +00:00
OpenStack Proposal Bot 7a78180c55 Updated from global requirements
Change-Id: Ic882fa4747fae55b5b2d61938f8e85fae05a7b06
2018-03-10 13:19:58 +00:00
OpenStack Proposal Bot 56c5f46a4d Updated from global requirements
Change-Id: I9704fa374b2f9a9680c35ed878f83632f2c6ef52
2017-09-21 03:41:55 +00:00
Tom Barron f829ae8e02 doc migration: openstackdocstheme completion
This patch completes the transition from oslosphinx
to openstackdocstheme in accord with the OpenStack
manuals project migration spec [1].

[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
Partial-Bug: #1706181
Needed-By: I6b876f6e697659a5fe7046d5c5d4fd4ed98f9828
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454

Change-Id: I834fbef9783739fd664246ff710df1ab42ce2af5
2017-08-21 08:29:00 -04:00
OpenStack Proposal Bot 607fbe3965 Updated from global requirements
Change-Id: I1ee9bfd72c0cb9689175467586ef98a717b2c004
2017-06-27 12:12:26 +00:00
OpenStack Proposal Bot 81d8c0d964 Updated from global requirements
Change-Id: Ic2a7055ca4a0d00a1c3098029b816f49f2e2d1ab
2017-05-17 03:49:54 +00:00
OpenStack Proposal Bot 264e7278e2 Updated from global requirements
Change-Id: I3a3f45d86f468470b14b839d8afa23f7020c0f05
2017-03-27 12:18:15 +00:00
ricolin 748478edb0 Update test requirement
Since pbr already landed and the old version of hacking seems not
work very well with pbr>=2, we should update it to match global
requirement.
Partial-Bug: #1668848

Change-Id: I68cdf0090169ea7d1b18bd0dcc67b2a716f94118
2017-03-02 16:21:44 +08:00
OpenStack Proposal Bot 9da0958d12 Updated from global requirements
Change-Id: I9f1c00cdeef907b12c860c6bba125eb04d2f9145
2017-02-10 05:50:55 +00:00
OpenStack Proposal Bot 8ba70b8c8d Updated from global requirements
Change-Id: I6f5681ca360166f12db8e3e1ab72d6235a013597
2016-12-15 21:23:15 +00:00
Victoria Martinez de la Cruz 4cc362a7f1 Pin docutils version
The 0.13.1 release breaks some documentation jobs when it tries to build
docs with remote images. This has been reported upstream[0]. The version
matches the supported docutils versions for sphinx.

The requirements patch is here: [1]

[0] https://sourceforge.net/p/docutils/bugs/301/
[1] https://review.openstack.org/#/c/409529/

Change-Id: I13832c4103f5c2a3fd9271e1ed55598d786f6bde
2016-12-12 18:47:05 -03:00
OpenStack Proposal Bot 2edee14380 Updated from global requirements
Change-Id: I6e2e3b012d571a997d0b8333feee082e542c6a2f
2016-12-02 21:04:40 +00:00
OpenStack Proposal Bot 331e33be92 Updated from global requirements
Change-Id: I6048b600597ac2a8abafdaca9cab9eddcd83dbdd
2016-06-21 18:00:28 +00:00
OpenStack Proposal Bot 642783c98d Updated from global requirements
Change-Id: I7347d8c36ab59ca61e95c4001693c25a8c2642ef
2016-03-03 01:15:25 +00:00
Igor Malinovskiy 50336185d9 Align project with default openstack project structure 2015-06-03 16:18:32 +03:00