From f2548eacf2ae70f90bf486714fabf09a11d5d15d Mon Sep 17 00:00:00 2001 From: Aric Gardner Date: Tue, 18 Sep 2018 11:06:02 -0400 Subject: Local Documentation Builds This adds configuration for performing local documentation builds with the following simple command: tox -e docs Change-Id: I8d7b3af60c12f4d426e3d6fc64eae66b356d94a6 Signed-off-by: Aric Gardner --- docs/conf.py | 1 + docs/conf.yaml | 3 +++ docs/index.rst | 6 +++--- docs/requirements.txt | 2 ++ 4 files changed, 9 insertions(+), 3 deletions(-) create mode 100644 docs/conf.py create mode 100644 docs/conf.yaml create mode 100644 docs/requirements.txt (limited to 'docs') 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..a665899 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: STORPERF diff --git a/docs/index.rst b/docs/index.rst index 5ed81af..c25a577 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -39,15 +39,15 @@ StorPerf User Guide ./testing/user/storperf-reporting.rst ****************************** -StorPerf Dev Guide +StorPerf Developer Guide ****************************** .. toctree:: - :caption: StorPerf Dev Guide + :caption: StorPerf Developer Guide :maxdepth: 5 :numbered: 5 - ./dev/index.rst + ./testing/developer/devguide/index.rst Indices 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 -- cgit 1.2.3-korg