From: Jeremy Stanley <fungi@yuggoth.org>
Date: Mon, 30 Apr 2018 19:41:32 +0000 (+0000)
Subject: Add a docs tox env
X-Git-Tag: 0.0.1~92
X-Git-Url: https://mudpy.org/gitweb?a=commitdiff_plain;h=002c2e4c75bca08126d87b3bb9a33ee5e26532da;p=mudpy.git

Add a docs tox env

Provide a convenience environment definition for using tox to build
project documentation.
---

diff --git a/tox.ini b/tox.ini
index b4464e2..00cbe22 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,4 +1,4 @@
-# Copyright (c) 2016-2017 Jeremy Stanley <fungi@yuggoth.org>. Permission
+# Copyright (c) 2016-2018 Jeremy Stanley <fungi@yuggoth.org>. Permission
 # to use, copy, modify, and distribute this software is granted under
 # terms provided in the LICENSE file distributed with this software.
 
@@ -12,11 +12,18 @@ basepython = python3
 usedevelop = True
 install_command = pip install {opts} {packages}
 setenv =
-   VIRTUAL_ENV={envdir}
-   PYTHONWARNINGS=default::DeprecationWarning
+    VIRTUAL_ENV={envdir}
+    PYTHONWARNINGS=default::DeprecationWarning
 deps = -r{toxinidir}/test-requirements.txt
 commands = python setup.py test --slowest --testr-args='{posargs}'
 
+[testenv:docs]
+deps =
+    -r{toxinidir}/requirements.txt
+    -r{toxinidir}/doc/requirements.txt
+commands =
+    sphinx-build -W -d doc/build/doctrees -b html doc/source/ doc/build/html
+
 [testenv:flake8]
 commands = flake8 {posargs}