Commit Graph

14 Commits

Author SHA1 Message Date
Hervé Beraud 45df91ada8 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].
Removing 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: Iac7d5ec69724206453c5fc74cbd61efde9b9a1ee
2021-01-11 15:07:40 +01:00
Andreas Jaeger 30fdf5ff21 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.

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.

Set openstackdocs_auto_name to use 'project' 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.

Depends-On: https://review.opendev.org/729744
Change-Id: Ia2c49cfc3a933a04d6ee4aea6c827935bebd3c41
2020-05-20 21:47:56 +02:00
Andreas Jaeger a09afa37b0 Update hacking for Python3
The repo is Python 3 now, so update hacking to version 3.0 which
supports Python 3.

Fix problems found by updated hacking version.

Remove hacking and friends from lower-constraints, they are not needed
there.

Change-Id: I14aee6250d80b7485c5c582a20abf4efafcc28c2
2020-03-31 22:07:59 +02:00
jacky06 4d6b0fa1c0 Replace git.openstack.org URLs with opendev.org URLs
Change-Id: I9db86cdb44bf72c6aefe63df6dd35e2399844871
2019-05-22 10:50:59 +02:00
Ian Wienand 95e2cc2da9 Replace openstack.org git:// URLs with https://
This is a mechanically generated change to replace openstack.org
git:// URLs with https:// equivalents.

This is in aid of a planned future move of the git hosting
infrastructure to a self-hosted instance of gitea (https://gitea.io),
which does not support the git wire protocol at this stage.

This update should result in no functional change.

For more information see the thread at

 http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003825.html

Change-Id: I3d07ca6f9c67c306d9aa1b56c6c103f6c43177e7
2019-03-24 20:35:53 +00:00
Zuul acb6a580ec Merge "Clean up README.rst" 2018-07-24 12:21:49 +00:00
Witold Bedyk c598eda377 Clean up README.rst
Move installation information to doc directory.

Change-Id: Ib0f155e5557930a642f947d668ac0e9cc061f72d
Story: 2001980
Task: 23115
2018-07-24 13:12:09 +02:00
Zuul 7c7f781907 Merge "Restore old content of reference/index.rst" 2018-07-24 06:05:19 +00:00
Witold Bedyk 32b82a5aae Move CLI usage examples to doc/cli directory
Change-Id: Ie114d8e46a7f84f6cb18f3f8d348de6572052006
Story: 2001980
Task: 23113
2018-07-23 14:45:20 +02:00
Witold Bedyk 99e2af611e Restore old content of reference/index.rst
Change-Id: Ibae00fb642099c57dec6ca118c20795a70a83980
Story: 2001980
Task: 23110
2018-07-23 13:48:14 +02:00
jacky06 f0be78d01f Remove the duplicated word
Change-Id: Ie88a536e970a24a3f749fa90dcdc6aa08f6ab8e2
2018-07-10 13:51:02 -04:00
Denis Poisson 2f40c7595b Redistribute README to doc/source
Change-Id: I510a53f3889f2ca01e314acb7582fed647e18fef
story: 2001980
task: 19597
2018-05-22 08:52:27 +02:00
Witold Bedyk 1b3c0665b5 Update usage examples
* Fix trivial bug
* Use default endpoints in devstack deployment

Change-Id: I7214fea9c5ff4ac5a0b8733053131d95c96c1556
2018-01-10 15:42:48 +01:00
kornicameister 6edcdd4af7 Enable client documentation
Commit enables following flavours of client's documentation:
- docs: featuring mainly CLI and Python API
- releasenotes: containing all releases releasenotes

Story: 2001058
Task: 5722

Needed-By: Ie064df6f64ee168ad3b5d2dda949b1d14fa7b9d8
Change-Id: I1b0fa11160d8d7d928b4cfbe358ca8c75ed8dd08
2017-11-21 17:31:06 +01:00