From: Balaji Shankaran Date: Mon, 18 Nov 2019 09:46:51 +0000 (+0530) Subject: Configuring repo for documentation X-Git-Tag: 1.0.1~2 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;ds=sidebyside;h=34c7e2763182af6377e3a5529c2ed3e9264c1043;hp=62ca5cdacefc1df4dbfafad05087649f1bfedf79;p=o-du%2Fl2.git Configuring repo for documentation Change-Id: I780585983abd441c358250bd12e6fba5349366a0 Signed-off-by: Balaji Shankaran --- diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..9c14461d7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +# documentation +.tox +docs/_build/ diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..095222aca --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,16 @@ +--- +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/Dockerfile b/Dockerfile index eda172454..6c0b7bf76 100644 --- a/Dockerfile +++ b/Dockerfile @@ -7,4 +7,4 @@ RUN apt-get update && apt-get install -y libpcap-dev RUN cd build/odu && make clean_all odu MACHINE=BIT64 MODE=FDD -CMD /opt/o-du-l2/bin/odu/odu +#CMD /opt/o-du-l2/bin/odu/odu -f ../config/ssi_mem diff --git a/Dockerfile-cu-stub b/Dockerfile-cu-stub index 61148a2a1..0f32d69b2 100644 --- a/Dockerfile-cu-stub +++ b/Dockerfile-cu-stub @@ -7,4 +7,4 @@ RUN apt-get update && apt-get install -y libpcap-dev RUN cd build/odu && make clean_all cu_stub MACHINE=BIT64 MODE=FDD -CMD /opt/o-du-l2/bin/cu_stub/cu_stub +#CMD /opt/o-du-l2/bin/cu_stub/cu_stub -f ../config/ssi_mem diff --git a/docs/README b/docs/README index 91d4f148b..fef88c391 100644 --- a/docs/README +++ b/docs/README @@ -4,6 +4,8 @@ Directory Structure : a. common : contains individual module's makefile b. config : contains SSI memory configuration c. odu : contains main makefile to generate an executable binary + +2. l2/docs/ : contains README and other configuration files for building docs 2. l2/src/ : contains layer specific source code a. 5gnrmac : MAC source code diff --git a/docs/_static/logo.png b/docs/_static/logo.png new file mode 100644 index 000000000..d6c084e99 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 000000000..922e22fb4 --- /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 000000000..149b23299 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: oran +project: o-du-l2 diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100644 index 000000000..00b0fd0ef 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 000000000..2c75a0f47 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,19 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 + + +Welcome to O-RAN SC o-du-l2 Documentation +=========================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + overview.rst + release-notes.rst + + + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/overview.rst b/docs/overview.rst new file mode 100644 index 000000000..ea4ac330c --- /dev/null +++ b/docs/overview.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 + + +O-DU implements the functional blocks of L2 layer of a 5G NR protocol stacks. +These layers primarily include NR MAC and NR RLC layers. +In order to manage these layers, DU_APP submodule has been introduced which can be comsidered as the +master module of O-DU. + + + +o-du-l2 Overview +====================== diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 237a71aa3..6f626e7d3 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -10,7 +10,7 @@ This document provides the release notes for of . Version history ---------------- +=============== +--------------------+--------------------+--------------------+--------------------+ | **Date** | **Ver.** | **Author** | **Comment** | diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt new file mode 100644 index 000000000..09a0c1cb0 --- /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 000000000..72742cff9 --- /dev/null +++ b/tox.ini @@ -0,0 +1,30 @@ +# 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