do not require installing demo app to build docs
Remove the dependency on the demoapp and just add it to the import path so it is available to be imported. Copy the entry point settings into the main cliff setup.cfg to ensure they are registered for the doc build to find. Change-Id: I390410bc5247e8b6c8d0a8fec8e7ecb223d8d6c1 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
parent
bc162de126
commit
3662d5a809
@ -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 ---------------------------------------------------
|
||||
|
||||
|
15
setup.cfg
15
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
|
||||
|
1
tox.ini
1
tox.ini
@ -19,7 +19,6 @@ commands =
|
||||
coverage report --show-missing
|
||||
deps =
|
||||
-r{toxinidir}/test-requirements.txt
|
||||
{toxinidir}/demoapp
|
||||
.[docs]
|
||||
|
||||
[testenv:pep8]
|
||||
|
Loading…
x
Reference in New Issue
Block a user