20ed3307d1
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. /!\/!\/!\ Notice that I voluntarily added the doc directory even if no docs are generated here because zuul will try to pull this requirements from there first and the contained requirements are needed for reno but AFAIK the releasenotes dir is ignored by zuul. c.f [4] for further details. /!\/!\/!\ [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: Ib224dfe036543c8ec7fe3074fe4280586d35de97 |
||
|---|---|---|
| doc | ||
| tools | ||
| www | ||
| .gitignore | ||
| .gitreview | ||
| .zuul.yaml | ||
| bindep.txt | ||
| LICENSE | ||
| README.rst | ||
| test-requirements.txt | ||
| tox.ini | ||
Team and repository tags
API-Site repository
This repository contains the index page for https://developer.openstack.org in the www directory.
To complete code reviews in this repository, use the standard OpenStack Gerrit workflow. For details, see Gerrit Workflow.
This repository is in a frozen state, it will be fully retired once a new home is found for the index page.
Prerequisites
To build the documentation locally, you must install Python and Python Tox.
To install Tox for Ubuntu 14.04 or later:
apt-get install python-tox python-dev libxml2-dev libxslt1-devTo build all the documentation after installing Python and Tox:
tox -e docsTo build an individual document, such as the API Guide:
tox -e api-quick-startThe locally-built output files are found in a
publish-docs directory.
Run tests
To use the same tests that are used as part of our Jenkins gating
jobs, install the Python tox package and run tox from the
top-level directory.
To run individual tests:
tox -e publishdocs- Builds all of the documents in this repository, this is called from CI jobs.
Contribute
Our community welcomes everyone who is interested in open source cloud computing and encourages you to join the OpenStack Foundation.
The best way to get involved with the community is to talk with
others online or at a meetup and offer contributions through our
processes, the OpenStack wiki,
blogs, or on IRC at #openstack on
irc.freenode.net.
We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.
To contribute to the documents, see OpenStack Documentation Contributor Guide.
Bugs
File bugs on Launchpad and not through GitHub:
Install
To learn more about the OpenStack project, see OpenStack.
Release Notes
- Release notes for the project can be found at: