From: Aric Gardner Date: Tue, 1 Oct 2019 21:13:08 +0000 (-0400) Subject: Updates to use lfdocs theme X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F49%2F1049%2F1;p=doc.git Updates to use lfdocs theme Signed-off-by: Aric Gardner Change-Id: I79f7ea58e60d0a79628229a86539336867db6796 --- diff --git a/docs/bar.rst b/docs/bar.rst new file mode 100644 index 0000000..347d13b --- /dev/null +++ b/docs/bar.rst @@ -0,0 +1,12 @@ +.. _bar: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 + +================= +Platform overview +================= + +Introduction +============ + diff --git a/docs/conf.py b/docs/conf.py index 592a573..3c4453e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,2 +1 @@ -from docs_conf import * -master_doc = 'index' +from docs_conf.conf import * diff --git a/docs/conf.yaml b/docs/conf.yaml index 5427b57..c46cce4 100644 --- a/docs/conf.yaml +++ b/docs/conf.yaml @@ -1,3 +1,3 @@ --- project_cfg: oran -project: ORAN +project: oran diff --git a/docs/index.rst b/docs/index.rst index e60834d..a42f61a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,11 +1,32 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 -.. _test: +.. _oran: + +Oran +==== + +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod +tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim +veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea +commodo consequat. Duis aute irure dolor in reprehenderit in voluptate +velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat +cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id +est laborum. + +Guides: + +.. toctree:: + :maxdepth: 1 + + bar + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` -======================= -Test Docs for rdt apiv3 -======================= -This is a test text -test diff --git a/tox.ini b/tox.ini index b383cec..db50ddf 100644 --- a/tox.ini +++ b/tox.ini @@ -17,7 +17,9 @@ deps = 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]