Signed-off-by: weichen <niweichen@chinamobile.com>
Change-Id: Ibd08a2d4b77cd4fc9ea0114bf78072711ea03e78
--- /dev/null
+---
+# .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
--- /dev/null
+from docs_conf.conf import *
+linkcheck_ignore = [
+ 'http://localhost.*',
+ 'http://127.0.0.1.*',
+ 'https://gerrit.o-ran-sc.org.*'
+]
--- /dev/null
+---
+project_cfg: oran
+project: pti-rtp
--- /dev/null
+
+.. rtp documentation master
+
+Welcome to RTP ducomentation
+============================
+
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+ overview.rst
+ developer-guide.rst
+ release-notes.rst
+
+* :ref:`search`
--- /dev/null
+..please write your project overview
+..please delete this content after editing
+
+
+RTP Overview
+============
.. http://creativecommons.org/licenses/by/4.0
.. http://creativecommons.org/licenses/by/4.0
+Release-notes
+=============
+
+
This document provides the release notes for <RELEASE> of <COMPONENT>.
.. contents::
This document provides the release notes for <RELEASE> of <COMPONENT>.
.. contents::
<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
<STATE RELEVANT RELEASE DATA/RECORDS>
<EXAMPLE>:
+--------------------------------------+--------------------------------------+
<STATE RELEVANT RELEASE DATA/RECORDS>
<EXAMPLE>:
+--------------------------------------+--------------------------------------+
-| **Project** | E.g. Arno/genesis/fuel@opnfv |
+| **Project** | E.g. project |
| | |
+--------------------------------------+--------------------------------------+
| **Repo/commit-ID** | E.g. genesis/adf634a0d4..... |
| | |
+--------------------------------------+--------------------------------------+
| **Repo/commit-ID** | E.g. genesis/adf634a0d4..... |
| **Release date** | E.g. 2015-04-16 |
| | |
+--------------------------------------+--------------------------------------+
| **Release date** | E.g. 2015-04-16 |
| | |
+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery** | E.g. OPNFV Internal quality assurance|
+| **Purpose of the delivery** | |
| | |
+--------------------------------------+--------------------------------------+
| | |
+--------------------------------------+--------------------------------------+
<STATE ADDED FEATURES BY REFERENCE TO JIRA>
<EXAMPLE>:
<STATE ADDED FEATURES BY REFERENCE TO JIRA>
<EXAMPLE>:
+--------------------------------------+--------------------------------------+
Bug corrections
+--------------------------------------+--------------------------------------+
Bug corrections
+--------------------------------------+--------------------------------------+
Deliverables
+--------------------------------------+--------------------------------------+
Deliverables
<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
Documentation deliverables
Documentation deliverables
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+++++++++++++++++++++++++++
<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
Known Limitations, Issues and Workarounds
Known Limitations, Issues and Workarounds
-=========================================
+-----------------------------------------
<STATE ALL RELEVANT SYSTEM LIMITATIONS, IF THERE IS ANY>
Known issues
<STATE ALL RELEVANT SYSTEM LIMITATIONS, IF THERE IS ANY>
Known issues
<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
<EXAMPLE>:
<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
<EXAMPLE>:
+--------------------------------------+--------------------------------------+
Workarounds
+--------------------------------------+--------------------------------------+
Workarounds
<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE, IF THERE IS ANY>
<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE, IF THERE IS ANY>
<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
--- /dev/null
+# 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
+
--- /dev/null
+[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