summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZuul <zuul@review.openstack.org>2017-12-04 01:25:41 +0000
committerGerrit Code Review <review@openstack.org>2017-12-04 01:25:41 +0000
commit1b037aee0fd0a7a58df9be87acf456869eef4e19 (patch)
tree9279c408ef4440c4af922dd61f716c9e89d531a2
parent9da56963e5489016b672022d6fc7311769b5a014 (diff)
parent3662d5a80917eef2042c7f04582a8a77cefaf3b9 (diff)
downloadcliff-1b037aee0fd0a7a58df9be87acf456869eef4e19.tar.gz
Merge "do not require installing demo app to build docs"
-rw-r--r--doc/source/conf.py7
-rw-r--r--setup.cfg15
-rw-r--r--tox.ini1
3 files changed, 21 insertions, 2 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 7c72ba7..63a342f 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -13,7 +13,9 @@
# serve to show the default.
import datetime
+import os.path
import subprocess
+import sys
# make openstackdocstheme an optional dependency. cliff is a low level lib
# that is used outside of OpenStack. Not having something OpenStack specific
@@ -28,7 +30,10 @@ else:
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
-# sys.path.insert(0, os.path.abspath('.'))
+
+# NOTE(dhellmann): Add the demoapp directory to the import path so the
+# directive for documenting the app can find the modules.
+sys.path.insert(0, os.path.abspath('../../demoapp'))
# -- General configuration ---------------------------------------------------
diff --git a/setup.cfg b/setup.cfg
index e451bfb..19904b0 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -50,6 +50,21 @@ cliff.formatter.completion =
bash = cliff.complete:CompleteBash
none = cliff.complete:CompleteNoCode
+# NOTE(dhellmann): Duplicated from demoapp/setup.py for the
+# documentation build.
+cliff.demo =
+ simple = cliffdemo.simple:Simple
+ two_part = cliffdemo.simple:Simple
+ error = cliffdemo.simple:Error
+ list files = cliffdemo.list:Files
+ files = cliffdemo.list:Files
+ file = cliffdemo.show:File
+ show file = cliffdemo.show:File
+ unicode = cliffdemo.encoding:Encoding
+ hooked = cliffdemo.hook:Hooked
+cliff.demo.hooked =
+ sample-hook = cliffdemo.hook:Hook
+
[build_sphinx]
all-files = 1
diff --git a/tox.ini b/tox.ini
index 21aacea..929d28f 100644
--- a/tox.ini
+++ b/tox.ini
@@ -19,7 +19,6 @@ commands =
coverage report --show-missing
deps =
-r{toxinidir}/test-requirements.txt
- {toxinidir}/demoapp
.[docs]
[testenv:pep8]