The general guide to contributing to OpenStack.
Go to file
Andreas Jaeger df6816f81a Update tox.ini
Split up doc8 commandline, use separate doc8 section for it to better
visualize what we do. Remove things that are not needed for this repo
since doc8 only checks below doc directory, include also README file for
checking.

Add -d option to sphinx-build so that the doctrees directory does not
get published.

Fix also two occurences of UTF-8 characters in intro.rst, we can use
ASCII everywhere and use a normal '.

Change-Id: Ib81ccba6ad92e2d07ff96d48746696454986d3ed
2018-11-18 16:34:11 +01:00
doc/source Update tox.ini 2018-11-18 16:34:11 +01:00
.gitignore Add Apple OS X ".DS_Store" to ".gitignore" file 2018-08-10 09:27:48 +00:00
.gitreview Added .gitreview 2017-10-10 20:34:48 +00:00
.zuul.yaml Update docs publishing 2018-08-25 10:34:33 +02:00
LICENSE Initial commit of the Contributor Portal 2017-10-16 15:43:49 -07:00
README.rst Fix some URLs 2018-11-08 10:46:31 +01: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 Update the home-page link 2018-08-24 04:30:01 -04:00
setup.py Initial commit of the Contributor Portal 2017-10-16 15:43:49 -07:00
test-requirements.txt Update tox.ini, enable doc8 2018-03-02 20:40:51 +01:00
tox.ini Update tox.ini 2018-11-18 16:34:11 +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.