Commit Graph

7 Commits

Author SHA1 Message Date
Hervé Beraud 19b2e15cee Add doc/requirements
We need to specify doc requirements in doc/requirements.txt
to avoid problems with the pip resolver [1] for the release team [2][3].
Removed specific doc requirements from test-requirements.txt.

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: Iddc6f1d90f416b8938a712ac0b04aec807f391a9
2024-01-26 01:07:33 +00:00
niuke 5c01e19b38 remove unicode from code
Change-Id: I248fa08a60a548908d6890e61f578b7b7f9aefa6
2022-07-28 10:19:17 +08:00
Andreas Jaeger b3613ff708 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.

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: I7966fa4281dde7e6340d632333ea8f8b84128bde
2020-06-02 14:00:56 +02:00
Thomas Bechtold e379747cd8 Drop oslosphinx and use openstackdocstheme
OpenStack moved to openstackdocstheme so use it here instead of
oslosphinx.
Also update the used Sphinx version. This is now in sync with the
versions from requirements/global-requirements.txt .

Change-Id: I0ffbea9b83abe9d9ae3886e7a427fc01637b36ea
2019-09-24 09:51:07 +02:00
aditi 146dcb20b1 Remove link to modindex
The documentation build does not generate any module index, thus
remove the link to the page. The page
http://docs.openstack.org/developer/ceilometermiddleware
/py-modindex.html does not exists

Change-Id: I690c59ef1d999d437162f59939c64b00b19ebed9
2017-01-27 11:29:53 +05:30
ZhiQiang Fan 07f8e677e8 [Trivial] Remove executable privilege of doc/source/conf.py
It is a configuration file rather than a script.

Change-Id: I4a19b92912a96bca5c11616ff87d9c8d85ce617a
2016-04-29 19:31:19 +08:00
gordon chung 5a5dbbbee7 initial checkin 2015-01-20 18:36:18 -05:00