From df6816f81af2c6046345fe6544a6a1232f674245 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sun, 18 Nov 2018 16:25:29 +0100 Subject: [PATCH] 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 --- doc/source/contributing/intro.rst | 2 +- tox.ini | 11 +++++++++-- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/doc/source/contributing/intro.rst b/doc/source/contributing/intro.rst index 705e2ae..1e9419f 100644 --- a/doc/source/contributing/intro.rst +++ b/doc/source/contributing/intro.rst @@ -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. diff --git a/tox.ini b/tox.ini index 4a0751f..9f14297 100644 --- a/tox.ini +++ b/tox.ini @@ -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