diff --git a/.gitignore b/.gitignore index 17ee4ebb..50f0861f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,8 @@ *.py[co] +# Documentation +doc/_build/ + # Packages *.egg *.egg-info diff --git a/.travis.yml b/.travis.yml index 288c76db..ece3ead2 100644 --- a/.travis.yml +++ b/.travis.yml @@ -6,6 +6,8 @@ matrix: env: TOXENV=py27 - python: 2.7 env: TOXENV=lint + - python: 2.7 + env: TOXENV=docs install: - pip install tox diff --git a/doc/_static/.git-dont-delete-me b/doc/_static/.git-dont-delete-me new file mode 100644 index 00000000..e69de29b diff --git a/doc/actionsmap.rst b/doc/actionsmap.rst index dce5ca14..aa28c6df 100644 --- a/doc/actionsmap.rst +++ b/doc/actionsmap.rst @@ -2,7 +2,7 @@ Role and syntax of the actionsmap ================================= -.. _actionmap: +.. _actionsmap: Principle ========= diff --git a/moulinette/utils/process.py b/moulinette/utils/process.py index ccfc4873..0c9d2ded 100644 --- a/moulinette/utils/process.py +++ b/moulinette/utils/process.py @@ -46,7 +46,7 @@ def call_async_output(args, callback, **kwargs): Keyword arguments: - args -- String or sequence of program arguments - callback -- Method or object to call with output as argument - - **kwargs -- Additional arguments for the Popen constructor + - kwargs -- Additional arguments for the Popen constructor Returns: Exit status of the command @@ -167,7 +167,7 @@ def run_commands(cmds, callback=None, separate_stderr=False, shell=True, callback is given, a "subprocess.CalledProcessError" will be raised in case of command failure. - separate_stderr -- True to return command output as a 2-tuple - - **kwargs -- Additional arguments for the Popen constructor + - kwargs -- Additional arguments for the Popen constructor Returns: Number of failed commands diff --git a/tox.ini b/tox.ini index 7c3a2648..7f2f8ac2 100644 --- a/tox.ini +++ b/tox.ini @@ -23,3 +23,11 @@ commands = flake8 moulinette test deps = flake8 skip_install = True usedevelop = False + +[testenv:docs] +usedevelop = True +commands = python -m sphinx -W doc/ doc/_build +deps = + sphinx + mock + gnupg