Merge pull request #485 from python-cmd2/sphinx_tests

Add tests which verify documentation build

Author: tleonhardt

.travis.yml

@@ -16,6 +16,9 @@ matrix:
         - os: linux
           python: 3.7-dev
           env: TOXENV=py37
+        - os: linux
+          python: 3.5
+          env: TOXENV=docs
 #        # Warning: Don't try to use code coverage analysis with pypy as it is insanely slow
 #        - os: linux
 #          python: pypy3

cmd2/cmd2.py

@@ -1652,8 +1652,8 @@ def preparse(self, raw: str) -> str:
         If you want a reliable pre parsing hook method, register a postparsing
         hook, modify the user input, and then reparse it.
 
-        :param raw: raw command line input :return: potentially modified raw
-        command line input
+        :param raw: raw command line input :return: potentially modified raw command line input
+        :return: a potentially modified version of the raw input string
         """
         return raw
 

docs/conf.py

@@ -102,7 +102,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = []
 
 
 # -- Options for HTMLHelp output ------------------------------------------

docs/requirements.txt

@@ -4,14 +4,15 @@
     1) How to add custom command aliases using the alias command
     2) How to load an initialization script at startup
 """
-
+import os
 import cmd2
 
 class AliasAndStartup(cmd2.Cmd):
     """ Example cmd2 application where we create commands that just print the arguments they are called with."""
 
     def __init__(self):
-        super().__init__(startup_script='.cmd2rc')
+        alias_script = os.path.join(os.path.dirname(__file__), '.cmd2rc')
+        super().__init__(startup_script=alias_script)
 
 
 if __name__ == '__main__':

examples/alias_startup.py

@@ -73,8 +73,10 @@
     # development only dependencies
     # install with 'pip install -e .[dev]'
     'dev': [
-        'pytest', 'pytest-cov', 'tox', 'pylint', 'sphinx', 'sphinx-rtd-theme',
-        'sphinx-autobuild', 'invoke', 'twine>=1.11',
+        # for python 3.5 and earlier we need the third party mock module
+        "mock ; python_version<'3.6'",
+        'pytest', 'codecov', 'pytest-cov', 'pytest-mock', 'tox', 'pylint',
+        'sphinx', 'sphinx-rtd-theme', 'sphinx-autobuild', 'invoke', 'twine>=1.11',
     ]
 }
 

setup.py

@@ -1,5 +1,5 @@
 [tox]
-envlist = py34,py35,py36,py37,py35-win,py36-win,py37-win
+envlist = docs,py34,py35,py36,py37,py35-win,py36-win,py37-win
 
 [pytest]
 testpaths = tests
@@ -9,6 +9,14 @@ passenv = CI TRAVIS TRAVIS_* APPVEYOR*
 setenv =
     PYTHONPATH={toxinidir}
 
+[testenv:docs]
+basepython = python3.5
+deps =
+  sphinx
+  sphinx-rtd-theme
+changedir = docs
+commands = sphinx-build -a -W -T -b html -d {envtmpdir}/doctrees . {envtmpdir}/html
+
 [testenv:py34]
 deps =
   codecov