From af27662f2f47c46d996ed017f9d1b0679bf37bb4 Mon Sep 17 00:00:00 2001 From: Trevor Bramwell Date: Wed, 6 Jun 2018 15:00:49 +0200 Subject: Enable local documentation builds Adds a local conf.py and conf.yaml (using lfdocs-conf), to enable local docs build. Change-Id: Iaab750983f02476d9bccb6c9bcf2b38544d54d8c Signed-off-by: Trevor Bramwell --- docs/conf.py | 1 + docs/conf.yaml | 3 +++ docs/development/index.rst | 16 ++++++++++++++++ docs/index.rst | 15 +++++++++++++++ docs/release/index.rst | 18 ++++++++++++++++++ docs/requirements.txt | 2 ++ 6 files changed, 55 insertions(+) create mode 100644 docs/conf.py create mode 100644 docs/conf.yaml create mode 100644 docs/development/index.rst create mode 100644 docs/index.rst create mode 100644 docs/release/index.rst create mode 100644 docs/requirements.txt (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..86ab8c57 --- /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 00000000..d38bbda4 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: sfc diff --git a/docs/development/index.rst b/docs/development/index.rst new file mode 100644 index 00000000..5644372b --- /dev/null +++ b/docs/development/index.rst @@ -0,0 +1,16 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +.. _sfc-development: + +========================= +Development Documentation +========================= + +.. toctree:: + :numbered: + :maxdepth: 2 + + requirements/index + design/index diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..73e87a9b --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +.. _sfc: + +========================= +Service Function Chaining +========================= + +.. toctree:: + :maxdepth: 1 + + release/index + development/index diff --git a/docs/release/index.rst b/docs/release/index.rst new file mode 100644 index 00000000..2fc72e92 --- /dev/null +++ b/docs/release/index.rst @@ -0,0 +1,18 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +.. _sfc-release: + +==================== +Release Documetation +==================== + +.. toctree:: + :numbered: + :maxdepth: 1 + + configguide/index + release-notes/index + scenarios/index + userguide/index diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..dcb7a594 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +lfdocs-conf +sphinx-opnfv-theme -- cgit 1.2.3-korg