Commit Graph

7 Commits

Author SHA1 Message Date
Hervé Beraud 616b463b74 Add doc/requirements
This project isn't released but uniformization can't hurt.

The origin of these changes was that 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 could meet similar 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: I0101b340fef5ae465eb64e7d7b21973d36fd2a6a
2021-01-07 11:24:12 +01:00
Andreas Jaeger b6859cc4c5 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.

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.

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: Ib928a4799233cf1d85a2b045bd7323c0576c72cb
2020-06-03 20:48:16 +02:00
Andreas Jaeger a0ec636cfe Cleanup py27 support
This repo is now testing only with Python 3, so let's make
a few cleanups:
- 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

Change-Id: I7582abcbf237320b0707732270388f113d93349d
2020-04-12 18:45:17 +02:00
Tony Breeds 8a9fd2ba04 Add linting for the sig.yaml
And correct a couple of small issues.

Change-Id: I8fcdf0a9387aff7be01bccbd9b10a84a88df4080
2019-11-12 15:40:58 +11:00
pengyuesheng 94d68aac73 Sync Sphinx requirement
Sync sphinx dependency with global requirements. It caps python 2 since
sphinx 2.0 no longer supports Python 2.7.

Change-Id: I46bb58b52da2c2817be7bd73bcbd0ebe61b9c695
2019-08-02 14:38:40 +08:00
Thierry Carrez 67c91ef194 Inherit openstackdocstheme
The SIGs governance website was using an old oslosphinx-based
theme. Inherit from openstackdocstheme instead, in the same way
as the TC site.

Change-Id: I2b5940eae121f0c73fc2e5a6758f5ad106c0d33c
2018-10-02 11:46:08 +02:00
Thierry Carrez b73404484c Set up initial content
Initial content for the SIG website, including information on
the Meta SIG.

Change-Id: I92741f1d166e31c1c976f33d2de432111975aa6c
2017-11-28 15:24:03 +01:00