The general guide to contributing to OpenStack.
Go to file
Andreas Jaeger b6e905018e 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_version to not auto-version the documents.

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: I5ff3f372c12db0efeb26737b31006e88ddc238a0
2020-06-03 20:59:27 +02:00
doc/source Switch to newer openstackdocstheme version 2020-06-03 20:59:27 +02:00
.gitignore Add Apple OS X ".DS_Store" to ".gitignore" file 2018-08-10 09:27:48 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:29:51 +00:00
.zuul.yaml use promote job 2019-08-21 20:33:21 +02:00
LICENSE Initial commit of the Contributor Portal 2017-10-16 15:43:49 -07:00
README.rst Replace git.openstack.org URLs with opendev.org URLs 2019-05-06 01:09:18 +08:00
bindep.txt Add minimal bindep file 2017-10-24 19:41:41 +02:00
requirements.txt Add test-requirements.txt 2017-11-17 20:31:18 +01:00
setup.cfg [ussuri][goal] Drop python 2.7 support and testing 2020-02-05 19:52:39 +01:00
setup.py [ussuri][goal] Drop python 2.7 support and testing 2020-02-05 19:52:39 +01:00
test-requirements.txt Switch to newer openstackdocstheme version 2020-06-03 20:59:27 +02:00
tox.ini [ussuri][goal] Drop python 2.7 support and testing 2020-02-05 19:52:39 +01:00

README.rst

Team and repository tags

image

The OpenStack Contributor Guide

The Contributor Guide for the OpenStack project.

To build the guide, execute the following command:

$ tox -e docs

After running tox -e docs, the guide will be available for viewing in HTML format in the doc/build/ directory.