diff --git a/docs/conf.py b/docs/conf.py index ce51626..cbea582 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -2,9 +2,10 @@ # # sphinx-click documentation build configuration file -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) +import os +import sys + +sys.path.insert(0, os.path.abspath('../examples')) # -- General configuration ------------------------------------------------ @@ -15,7 +16,7 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ["sphinx_click"] +extensions = ['sphinx_click'] # Add any paths that contain templates here, relative to this directory. templates_path = [] diff --git a/docs/index.rst b/docs/index.rst index d7dc2d7..4017852 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,9 +1,9 @@ sphinx-click ============ -:mod:`sphinx-click ` is a `Sphinx`__ plugin that allows you to -automatically extract documentation from a `click-based`__ application and -include it in your docs. +``sphinx-click`` is a `Sphinx`__ plugin that allows you to automatically +extract documentation from a `click-based`__ application and include it in +your docs. __ http://www.sphinx-doc.org/ __ http://click.pocoo.org/ @@ -19,9 +19,9 @@ __ http://click.pocoo.org/ .. seealso:: - Module :mod:`click` - This extension assumes you are using :mod:`click` to create your command + Module ``click`` + This extension assumes you are using ``click`` to create your command line application. - Module :mod:`sphinxcontrib.autoprogram` - An equivalent library for use with :mod:`argparse`. + Module ``sphinxcontrib.autoprogram`` + An equivalent library for use with ``argparse``. diff --git a/tox.ini b/tox.ini index fb4c757..a89c1d0 100644 --- a/tox.ini +++ b/tox.ini @@ -33,8 +33,7 @@ commands = [testenv:docs] commands = - pip install -e {toxinidir}/examples/ - sphinx-build -W -b html -d docs/_build/doctrees docs docs/_build/html + sphinx-build -Wn -b html -d docs/_build/doctrees docs docs/_build/html [coverage:run] branch = True