From: Aric Gardner Date: Mon, 23 Sep 2019 17:06:27 +0000 (-0400) Subject: Add preliminary docs stuff X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F01%2F1001%2F5;p=doc.git Add preliminary docs stuff Ready for merge Signed-off-by: Aric Gardner Change-Id: I716f6d8abfc041a7f171b8b554e700ed102d0ff1 --- diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..71d7636 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.tox +docs/_build/* 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..592a573 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,2 @@ +from docs_conf import * +master_doc = 'index' diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 0000000..5427b57 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: oran +project: ORAN 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..e60834d --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,11 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 + +.. _test: + +======================= +Test Docs for rdt apiv3 +======================= + +This is a test text +test diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt new file mode 100644 index 0000000..09a0c1c --- /dev/null +++ b/docs/requirements-docs.txt @@ -0,0 +1,5 @@ +sphinx +sphinx-rtd-theme +sphinxcontrib-httpdomain +recommonmark +lfdocs-conf diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..b383cec --- /dev/null +++ b/tox.ini @@ -0,0 +1,30 @@ +[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