From 1ec589de26715445aeff3e565693f71e472e3496 Mon Sep 17 00:00:00 2001 From: Aric Gardner Date: Tue, 18 Sep 2018 11:05:47 -0400 Subject: Local Documentation Builds This adds configuration for performing local documentation builds with the following simple command: tox -e docs added index.rst so that docs build succsesfully Change-Id: Iab747c90f7f4b7866270c5850b2792e194b5378a Signed-off-by: Aric Gardner --- .gitignore | 2 ++ docs/conf.py | 1 + docs/conf.yaml | 3 +++ docs/index.rst | 16 ++++++++++++++++ docs/requirements.txt | 2 ++ tox.ini | 17 +++++++++++++++++ 6 files changed, 41 insertions(+) create mode 100644 docs/conf.py create mode 100644 docs/conf.yaml create mode 100644 docs/index.rst create mode 100644 docs/requirements.txt create mode 100644 tox.ini diff --git a/.gitignore b/.gitignore index b3c2444..9292c06 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,5 @@ *.*project build dist +.tox +docs/_build/* diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..3c4453e --- /dev/null +++ b/docs/conf.py @@ -0,0 +1 @@ +from docs_conf.conf import * diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 0000000..0bb596d --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: SNAPS diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..aceb2fc --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,16 @@ +.. _snaps: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. SPDX-License-Identifier CC-BY-4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +********************************* +OPNFV Snaps +********************************* + +.. toctree:: + :numbered: + :maxdepth: 3 + + /how-to-use/index 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 new file mode 100644 index 0000000..69aa189 --- /dev/null +++ b/tox.ini @@ -0,0 +1,17 @@ +[tox] +minversion = 1.6 +envlist = + docs, + docs-linkcheck +skipsdist = true + +[testenv:docs] +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 = -rdocs/requirements.txt +commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck -- cgit 1.2.3-korg