diff options
| author |   Shubham Mishra <shivam828787@gmail.com> | 2020-10-27 08:19:07 +0530 |
|---|---|---|
| committer | Shubham Mishra <shivam828787@gmail.com> | 2020-10-27 21:35:13 +0530 |
| commit | 7e3a24b9fd5d8f2e848ade291852e93b4b7a18ea (patch) | |
| tree | f8925f97bc50bc089b9ce67c827762d2313f9754 | |
| parent | 49bb7680b18be1bcf869fa1d317a27f265a59469 (diff) | |
Documentation template added
Signed-off-by: Shubham Mishra <shivam828787@gmail.com>
Change-Id: I42c83f7750ee23d6fac76074e91d2f5205a8a0cb
| -rw-r--r-- | docs/conf.py | 6 | ||||
| -rw-r--r-- | docs/conf.yaml | 3 | ||||
| -rw-r--r-- | docs/development/index.rst | 6 | ||||
| -rw-r--r-- | docs/index.rst | 17 | ||||
| -rw-r--r-- | docs/release/configguide/index.rst | 6 | ||||
| -rw-r--r-- | docs/release/release-notes/index.rst | 17 | ||||
| -rw-r--r-- | docs/release/release-notes/release-notes.rst | 7 | ||||
| -rw-r--r-- | docs/release/userguide/index.rst | 6 | ||||
| -rw-r--r-- | docs/requirements.txt | 2 |
9 files changed, 70 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..0a8fc85 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,6 @@ +""" for docs
+"""
+
+# pylint: disable=import-error
+# flake8: noqa
+from docs_conf.conf import *
diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 0000000..7b9e5e8 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +---
+project_cfg: opnfv
+project: CIRV-HDV
diff --git a/docs/development/index.rst b/docs/development/index.rst new file mode 100644 index 0000000..9aea6ec --- /dev/null +++ b/docs/development/index.rst @@ -0,0 +1,6 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c)
+
+CIRV-HDV Developer Guide
+========================
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..be87e23 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,17 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c)
+
+.. _cirv-hdv:
+
+**************
+OPNFV CIRV-HDV
+**************
+.. toctree::
+ :numbered:
+ :maxdepth: 3
+
+ release/release-notes/index
+ release/userguide/index
+ release/configguide/index
+ development/index
diff --git a/docs/release/configguide/index.rst b/docs/release/configguide/index.rst new file mode 100644 index 0000000..8e708b0 --- /dev/null +++ b/docs/release/configguide/index.rst @@ -0,0 +1,6 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c)
+
+CIRV-HDV Configuration Guide
+============================
diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst new file mode 100644 index 0000000..82d4068 --- /dev/null +++ b/docs/release/release-notes/index.rst @@ -0,0 +1,17 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Spirent Communicatios, University of Delhi and others.
+
+.. _cirvsdv-releasenotes:
+
+==================================================
+CIRV-HDV Release Notes
+==================================================
+
+.. toctree::
+ :numbered:
+ :maxdepth: 2
+
+ release-notes.rst
+
+Build date: |today|
diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst new file mode 100644 index 0000000..aa1b8ca --- /dev/null +++ b/docs/release/release-notes/release-notes.rst @@ -0,0 +1,7 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c)
+
+OPNFV Jerma Release
+====================
+
diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst new file mode 100644 index 0000000..bd6d785 --- /dev/null +++ b/docs/release/userguide/index.rst @@ -0,0 +1,6 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c)
+
+CIRV-HDV User Guide
+===================
diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..217618c --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +lfdocs-conf
+sphinx_opnfv_theme
|