MNT: Run docs through doc8.

brian-rose · Oct 4, 2016 · be4bef6 · be4bef6
1 parent 59e1283
commit be4bef6
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 6 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -95,9 +95,11 @@ script:
   - if [[ $TASK == "lint" ]]; then
       flake8 siphon;
     elif [[ $TASK == "docs" ]]; then
-      cd docs;
-      make html 2>docs.log;
-      if [ -s docs.log ]; then
+      pushd docs;
+      make html 2>../docs.log;
+      popd;
+      doc8 README.rst docs/source;
+      if [ -s docs.log -o $? -ne 0 ]; then
         echo Doc build produced warnings or errors:;
         cat docs.log;
         false;

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,4 +1,3 @@
 sphinx>=1.3
-nbconvert>=4.0
-# Until nbconvert 4.1
-IPython>=4.0
+nbconvert>=4.1
+doc8
diff --git a/setup.cfg b/setup.cfg
@@ -2,6 +2,10 @@
 max-line-length = 95
 exclude = siphon/cdmr/ncStream_pb2.py, siphon/cdmr/cdmrfeature_pb2.py
 
+[doc8]
+ignore-path = docs/source/examples/generated
+max-line-length = 95
+
 [metadata]
 description-file = README.rst