openstack
/
contributor-guide
Code Issues Proposed changes

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
This commit is contained in:
Andreas Jaeger 2018-11-18 16:25:29 +01:00
parent 8cb3950280
commit df6816f81a
2 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/contributing/intro.rst
View File

@ -4,7 +4,7 @@ Introduction and Goals
What is the Contributor Guide?
==============================
First it’s important to note that we’re not just talking about code projects.
First it's important to note that we're not just talking about code projects.
OpenStack contributions come in different forms such as running meet ups,
identifying use cases (Product Working Group), documentation, testing, etc. Our
goal is to have these contributions valued equally.

11
tox.ini
View File

@ -16,7 +16,14 @@ deps =
commands = {posargs}
[testenv:pep8]
commands = doc8 --ignore-path .tox --ignore-path *.egg-info --ignore-path doc/build --ignore-path .eggs/*/EGG-INFO/*.txt doc
commands = doc8 -v doc README.rst
[testenv:docs]
commands = sphinx-build -E -W -b html doc/source doc/build/html
commands = sphinx-build -E -W -b html -d doc/build/doctrees doc/source doc/build/html
[doc8]
# Settings for doc8:
# Ignore build directory
ignore-path = doc/build/
# File extensions to use
extensions = .rst,.txt