From: weichen Date: Mon, 4 Nov 2019 06:43:18 +0000 (-0500) Subject: add doc config files and doc [Dinitial draft X-Git-Tag: bronze-rc0~117 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=b6d2696fd594467a909102ed5f9262fdf332ec1e;p=pti%2Frtp.git add doc config files and doc [Dinitial draft Signed-off-by: weichen Change-Id: Ibd08a2d4b77cd4fc9ea0114bf78072711ea03e78 --- diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..3797dc8 --- /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/logo.png b/docs/_static/logo.png new file mode 100644 index 0000000..c3b6ce5 Binary files /dev/null and b/docs/_static/logo.png differ diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..922e22f --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,6 @@ +from docs_conf.conf import * +linkcheck_ignore = [ + 'http://localhost.*', + 'http://127.0.0.1.*', + 'https://gerrit.o-ran-sc.org.*' +] diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 0000000..fee1ea7 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: oran +project: pti-rtp diff --git a/docs/developer-guides.rst b/docs/developer-guide.rst similarity index 98% rename from docs/developer-guides.rst rename to docs/developer-guide.rst index 3084821..ed1c4ee 100644 --- a/docs/developer-guides.rst +++ b/docs/developer-guide.rst @@ -6,7 +6,7 @@ :local: Developer-Guides -============== +================ .. note: diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100644 index 0000000..00b0fd0 Binary files /dev/null and b/docs/favicon.ico differ diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..28fbf24 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,16 @@ + +.. rtp documentation master + +Welcome to RTP ducomentation +============================ + + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + overview.rst + developer-guide.rst + release-notes.rst + +* :ref:`search` diff --git a/docs/overview.rst b/docs/overview.rst new file mode 100644 index 0000000..52967b9 --- /dev/null +++ b/docs/overview.rst @@ -0,0 +1,6 @@ +..please write your project overview +..please delete this content after editing + + +RTP Overview +============ diff --git a/docs/release-notes.rst b/docs/release-notes.rst index b0d6530..ceb4bf8 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -2,6 +2,10 @@ .. http://creativecommons.org/licenses/by/4.0 +Release-notes +============= + + This document provides the release notes for of . .. contents:: @@ -28,7 +32,7 @@ Version history Summary -======= +------- @@ -36,13 +40,13 @@ Summary Release Data -============ +------------ : +--------------------------------------+--------------------------------------+ -| **Project** | E.g. Arno/genesis/fuel@opnfv | +| **Project** | E.g. project | | | | +--------------------------------------+--------------------------------------+ | **Repo/commit-ID** | E.g. genesis/adf634a0d4..... | @@ -54,7 +58,7 @@ Release Data | **Release date** | E.g. 2015-04-16 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | E.g. OPNFV Internal quality assurance| +| **Purpose of the delivery** | | | | | +--------------------------------------+--------------------------------------+ @@ -62,7 +66,7 @@ Release Data Feature additions -~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^ : @@ -83,7 +87,7 @@ Feature additions +--------------------------------------+--------------------------------------+ Bug corrections -~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^ **JIRA TICKETS:** @@ -101,34 +105,34 @@ Bug corrections +--------------------------------------+--------------------------------------+ Deliverables ----------------- +^^^^^^^^^^^^ Software deliverables -^^^^^^^^^^^^^^^^^^^^^^^ ++++++++++++++++++++++ -: + Documentation deliverables -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +++++++++++++++++++++++++++ -: + Known Limitations, Issues and Workarounds -========================================= +----------------------------------------- System Limitations -^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^ Known issues -^^^^^^^^^^^^^^^ +^^^^^^^^^^^^ : @@ -149,7 +153,7 @@ Known issues +--------------------------------------+--------------------------------------+ Workarounds -^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^ @@ -157,7 +161,7 @@ Workarounds References -========== +---------- diff --git a/docs/tox.ini b/docs/tox.ini new file mode 100644 index 0000000..dabc92c --- /dev/null +++ b/docs/tox.ini @@ -0,0 +1,31 @@ +# documentation only +[tox] +minversion = 2.0 +envlist = + docs, + docs-linkcheck, +skipsdist = true + +[testenv:docs] +basepython = python3 +deps = + sphinx + sphinx-rtd-theme + sphinxcontrib-httpdomain + recommonmark + lfdocs-conf + +commands = + sphinx-build -W -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 = sphinx + sphinx-rtd-theme + sphinxcontrib-httpdomain + recommonmark + lfdocs-conf +commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck + diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..db50ddf --- /dev/null +++ b/tox.ini @@ -0,0 +1,32 @@ +[tox] +minversion = 2.0 +envlist = + docs, + docs-linkcheck, + +skipsdist = true + +[testenv:docs] +basepython = python3 +deps = + sphinx + sphinx-rtd-theme + sphinxcontrib-httpdomain + recommonmark + lfdocs-conf + +commands = + sphinx-build -W -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 = sphinx + sphinx-rtd-theme + sphinxcontrib-httpdomain + recommonmark + lfdocs-conf +commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck