From ba638f983a4247e8bcf53e590b5e39e5016d6278 Mon Sep 17 00:00:00 2001 From: Trevor Bramwell Date: Wed, 5 Sep 2018 22:35:42 -0700 Subject: OVN4NFV Local Documentation Builds This adds configuration for performing local documentation builds with the following simple command: tox -e docs Change-Id: I757809ddd5f9b33fbcb1df295eaad41eaf28b8cd Signed-off-by: Trevor Bramwell --- docs/conf.py | 1 + docs/conf.yaml | 3 +++ docs/index.rst | 20 ++++++++++++++++++++ docs/requirements.txt | 2 ++ 4 files changed, 26 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 (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..7611686 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: OVN4NFV diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..50b855d --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,20 @@ +.. _ovn4nfv: + +.. 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 + +======= +OVN4NFV +======= + +.. toctree:: + :numbered: + :maxdepth: 2 + + development/index + release/configguide/index + release/release-notes/index + scenarios/index + testing/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 -- cgit 1.2.3-korg