summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--.gitignore1
-rw-r--r--docs/conf.py1
-rw-r--r--docs/conf.yaml3
-rw-r--r--docs/release/release-notes/index.rst4
-rw-r--r--docs/release/release-notes/release-notes.rst14
-rw-r--r--docs/requirements.txt5
-rw-r--r--tox.ini19
7 files changed, 39 insertions, 8 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..45e1b76
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+.tox/ docs/_build/*
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..eb12e74
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1 @@
+from docs_conf.conf import * # noqa: F401,F403
diff --git a/docs/conf.yaml b/docs/conf.yaml
new file mode 100644
index 0000000..a6ba00c
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: opnfv
+project: Airship
diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst
index d3a2f05..9b21d4b 100644
--- a/docs/release/release-notes/index.rst
+++ b/docs/release/release-notes/index.rst
@@ -1,8 +1,8 @@
.. _airship-releasenotes:
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) Bin Hu and Kaspars Skels (AT&T)
+.. SPDX-License-Identifier: CC-BY-4.0
+.. (c) Open Platform for NFV Project, Inc. and its contributors
.. toctree::
:maxdepth: 3
diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
index 752214b..7c567ac 100644
--- a/docs/release/release-notes/release-notes.rst
+++ b/docs/release/release-notes/release-notes.rst
@@ -1,6 +1,6 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) Bin Hu and Kaspars Skels (AT&T)
+.. SPDX-License-Identifier: CC-BY-4.0
+.. (c) Open Platform for NFV Project, Inc. and its contributors
=============================================
OPNFV Airship Installer Project Release Notes
@@ -18,6 +18,8 @@ Version History
+--------------------+--------------------+--------------------+----------------------+
| 2019-12-19 | 1.0.0 | Bin Hu | Iruya release |
+--------------------+--------------------+--------------------+----------------------+
+| 2020-12-?? | 2.0.0 | James Gu | Jerma release |
++--------------------+--------------------+--------------------+----------------------+
Release Data
------------
@@ -25,13 +27,13 @@ Release Data
+--------------------------------------+--------------------------------------+
| **Project** | Airship Installer |
+--------------------------------------+--------------------------------------+
-| **Repo/tag** | opnfv-9.0.0 |
+| **Repo/tag** | opnfv-10.0.0 |
+--------------------------------------+--------------------------------------+
-| **Release designation** | Iruya 9.0 |
+| **Release designation** | Jerma 10.0 |
+--------------------------------------+--------------------------------------+
-| **Release date** | January 10, 2020 |
+| **Release date** | December ??, 2020 |
+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery** | OPNFV Iruya 9.0 Release |
+| **Purpose of the delivery** | OPNFVJerma 10.0 Release |
+--------------------------------------+--------------------------------------+
Important Notes
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 0000000..4408435
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,5 @@
+lfdocs-conf
+sphinx_opnfv_theme
+# Uncomment the following line if your project uses Sphinx to document
+# HTTP APIs
+# sphinxcontrib-httpdomain
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 0000000..840ce6a
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,19 @@
+[tox]
+minversion = 1.6
+envlist =
+ docs,
+ docs-linkcheck
+skipsdist = true
+
+[testenv:docs]
+basepython = python3
+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]
+basepython = python3
+deps = -rdocs/requirements.txt
+commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck