From 002926186c3ad673770ca0686b2dcf043ad21c0f Mon Sep 17 00:00:00 2001 From: Aric Gardner Date: Tue, 6 Nov 2018 15:09:20 -0500 Subject: Fix local documentation builds Change-Id: Icba4f70704e7d51dd26b778350be2f3bf5adcaba Signed-off-by: Aric Gardner --- .gitignore | 2 ++ docs/conf.py | 1 + docs/conf.yaml | 4 ++++ docs/requirements.txt | 2 ++ tox.ini | 6 +++--- 5 files changed, 12 insertions(+), 3 deletions(-) create mode 100644 docs/conf.py create mode 100644 docs/conf.yaml create mode 100644 docs/requirements.txt diff --git a/.gitignore b/.gitignore index 0b8f528..9dd102d 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,5 @@ mongo*.conf mongo_access.log .DS_Store +.tox +docs/_build/* diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..86ab8c5 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1 @@ +from docs_conf.conf import * # flake8: noqa diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 0000000..39fb414 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,4 @@ +--- +project_cfg: opnfv +project: calipso + diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..9fde2df --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +lfdocs-conf +sphinx_opnfv_theme diff --git a/tox.ini b/tox.ini index c1993d9..dd5076d 100644 --- a/tox.ini +++ b/tox.ini @@ -4,12 +4,12 @@ envlist = docs,docs-linkcheck skipsdist = true [testenv:docs] -deps = -r{toxinidir}/etc/requirements.txt +deps = -rdocs/requirements.txt commands = sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html echo "Generated docs available in {toxinidir}/docs/_build/html" whitelist_externals = echo [testenv:docs-linkcheck] -deps = -r{toxinidir}/etc/requirements.txt -commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck \ No newline at end of file +deps = -rdocs/requirements.txt +commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck -- cgit 1.2.3-korg