summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorToine Siebelink <toine.siebelink@est.tech>2021-02-24 13:16:22 +0000
committerGerrit Code Review <gerrit@onap.org>2021-02-24 13:16:22 +0000
commit257b6cba072010dd24f1890d70b5ee08fea1d81b (patch)
tree7bfdef0d2ded397f964e41c15555fe04b7d5ac05
parent8c9b592e7e04d2d2a27c9da6befe7ea13aedadfd (diff)
parent5272dca758641a7752a3a4d9ccc9c4709aa68c4d (diff)
Merge "Initial/docs folder setup"
-rwxr-xr-x[-rw-r--r--].gitignore6
-rw-r--r--.readthedocs.yaml20
-rw-r--r--docs/_static/css/ribbon.css63
-rwxr-xr-xdocs/_static/favicon.icobin0 -> 2102 bytes
-rw-r--r--docs/_static/logo_onap_2017.pngbin0 -> 12278 bytes
-rwxr-xr-xdocs/conf.py21
-rw-r--r--docs/conf.yaml7
-rwxr-xr-xdocs/index.rst14
-rwxr-xr-xdocs/offeredapis.rst29
-rw-r--r--docs/requirements-docs.txt15
-rw-r--r--docs/tox.ini22
11 files changed, 196 insertions, 1 deletions
diff --git a/.gitignore b/.gitignore
index 624c9b63b9..f197492474 100644..100755
--- a/.gitignore
+++ b/.gitignore
@@ -20,4 +20,8 @@ tmp/
.classpath
.project
*.tmp
-.checkstyle \ No newline at end of file
+.checkstyle
+
+/.tox
+/_build/*
+/__pycache__/* \ No newline at end of file
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 0000000000..3797dc8bb9
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,20 @@
+---
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+# Required
+version: 2
+
+formats:
+ - htmlzip
+
+build:
+ image: latest
+
+python:
+ version: 3.7
+ install:
+ - requirements: docs/requirements-docs.txt
+
+sphinx:
+ configuration: docs/conf.py
diff --git a/docs/_static/css/ribbon.css b/docs/_static/css/ribbon.css
new file mode 100644
index 0000000000..6008cb1a08
--- /dev/null
+++ b/docs/_static/css/ribbon.css
@@ -0,0 +1,63 @@
+.ribbon {
+ z-index: 1000;
+ background-color: #a00;
+ overflow: hidden;
+ white-space: nowrap;
+ position: fixed;
+ top: 25px;
+ right: -50px;
+ -webkit-transform: rotate(45deg);
+ -moz-transform: rotate(45deg);
+ -ms-transform: rotate(45deg);
+ -o-transform: rotate(45deg);
+ transform: rotate(45deg);
+ -webkit-box-shadow: 0 0 10px #888;
+ -moz-box-shadow: 0 0 10px #888;
+ box-shadow: 0 0 10px #888;
+
+}
+
+.ribbon a {
+ border: 1px solid #faa;
+ color: #fff;
+ display: block;
+ font: bold 81.25% 'Helvetica Neue', Helvetica, Arial, sans-serif;
+ margin: 1px 0;
+ padding: 10px 50px;
+ text-align: center;
+ text-decoration: none;
+ text-shadow: 0 0 5px #444;
+ transition: 0.5s;
+}
+
+.ribbon a:hover {
+ background: #c11;
+ color: #fff;
+}
+
+
+/* override table width restrictions */
+@media screen and (min-width: 767px) {
+
+ .wy-table-responsive table td, .wy-table-responsive table th {
+ /* !important prevents the common CSS stylesheets from overriding
+ this as on RTD they are loaded after this stylesheet */
+ white-space: normal !important;
+ }
+
+ .wy-table-responsive {
+ overflow: visible !important;
+ }
+}
+
+@media screen and (max-width: 767px) {
+ .wy-table-responsive table td {
+ white-space: nowrap;
+ }
+}
+
+/* fix width of the screen */
+
+.wy-nav-content {
+ max-width: none;
+}
diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico
new file mode 100755
index 0000000000..cb712ebd20
--- /dev/null
+++ b/docs/_static/favicon.ico
Binary files differ
diff --git a/docs/_static/logo_onap_2017.png b/docs/_static/logo_onap_2017.png
new file mode 100644
index 0000000000..5d064f431c
--- /dev/null
+++ b/docs/_static/logo_onap_2017.png
Binary files differ
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100755
index 0000000000..1a8887e7be
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,21 @@
+from docs_conf.conf import *
+
+branch = 'latest'
+master_doc = 'index'
+extensions = [
+ 'sphinx.ext.autosectionlabel',
+ 'sphinxcontrib.swaggerdoc'
+ ]
+
+linkcheck_ignore = [
+ 'http://localhost',
+]
+
+intersphinx_mapping = {}
+
+html_last_updated_fmt = '%d-%b-%y %H:%M'
+
+autosectionlabel_maxdepth = 2
+
+def setup(app):
+ app.add_stylesheet("css/ribbon.css")
diff --git a/docs/conf.yaml b/docs/conf.yaml
new file mode 100644
index 0000000000..ab5928131c
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,7 @@
+---
+project_cfg: onap
+project: onap
+
+# Change this to ReleaseBranchName to modify the header
+default-version: latest
+#
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100755
index 0000000000..81c485fb0f
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,14 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
+.. _master_index:
+
+.. THIS IS USED INTERNALLY IN CPS ONLY
+.. _cps-framework-doc:
+
+CPS Documentation Repository
+-----------------------------
+
+.. toctree::
+ :maxdepth: 1
+
+ offeredapis.rst
diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst
new file mode 100755
index 0000000000..912c5d1960
--- /dev/null
+++ b/docs/offeredapis.rst
@@ -0,0 +1,29 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
+.. _offeredapis:
+
+
+CPS Offered APIs
+================
+
+CPS supports the public APIs listed in the links below:
+
+.. toctree::
+ :maxdepth: 1
+
+
+Exposed API
+-----------
+
+The standard for API definition in the RESTful API world is the OpenAPI Specification (OAS). The OAS 3, which is based on
+the original "Swagger Specification," is being widely used in API developments.
+
+Specification can be accesed locally at :
+
+.. code-block:: bash
+
+ “http://<hostname>:<port>/v3/api-docs?group=cps-docket”
+
+
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
new file mode 100644
index 0000000000..b3188ddd38
--- /dev/null
+++ b/docs/requirements-docs.txt
@@ -0,0 +1,15 @@
+tox
+Sphinx
+doc8
+docutils
+setuptools
+six
+sphinx_rtd_theme>=0.4.3
+sphinxcontrib-blockdiag
+sphinxcontrib-needs>=0.2.3
+sphinxcontrib-nwdiag
+sphinxcontrib-seqdiag
+sphinxcontrib-swaggerdoc
+sphinxcontrib-plantuml
+sphinx_bootstrap_theme
+lfdocs-conf
diff --git a/docs/tox.ini b/docs/tox.ini
new file mode 100644
index 0000000000..edac8c35fc
--- /dev/null
+++ b/docs/tox.ini
@@ -0,0 +1,22 @@
+[tox]
+minversion = 1.6
+envlist = docs,
+skipsdist = true
+
+[testenv:docs]
+basepython = python3
+deps = -r{toxinidir}/requirements-docs.txt
+commands =
+ sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
+ echo "Generated docs available in {toxinidir}/_build/html"
+whitelist_externals =
+ echo
+ git
+ sh
+
+[testenv:docs-linkcheck]
+basepython = python3
+#deps = -r{toxinidir}/requirements-docs.txt
+commands = echo "Link Checking not enforced"
+#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck
+whitelist_externals = echo