From: Claudio D. Gasparini Date: Mon, 17 May 2021 11:38:47 +0000 (+0200) Subject: Initial doc structure X-Git-Tag: 1.0.0~15^2 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=811e44e99a8884b2c316ea4a88ef88e75ee0e47d;p=oam%2Fnf-oam-adopter.git Initial doc structure Issue-ID: OAM-208 Signed-off-by: Claudio D. Gasparini Change-Id: I4f1784e2386275087c77b7814de19d49d767d96e --- diff --git a/.gitignore b/.gitignore index 2ce90d2..e156843 100644 --- a/.gitignore +++ b/.gitignore @@ -18,5 +18,6 @@ logs/ **/*.log #doc -/doc/_build +.tox +docs/_build/ /doc/pdf diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..095222a --- /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/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..c599d50 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,7 @@ +from docs_conf.conf import * + +linkcheck_ignore = [ + 'http://localhost.*', + 'http://127.0.0.1.*', + 'https://gerrit.o-ran-sc.org.*' +] \ No newline at end of file diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 0000000..3ffd339 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,5 @@ +--- +project_cfg: oran +project: nf-oam-adopter + +default-version: master diff --git a/docs/deployment-guide.rst b/docs/deployment-guide.rst new file mode 100644 index 0000000..69c1bde --- /dev/null +++ b/docs/deployment-guide.rst @@ -0,0 +1,8 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. + +Deployment Guide +================ + +This document provides a quickstart for deployment of the NF OAM Adopter. \ No newline at end of file diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst new file mode 100644 index 0000000..08153d6 --- /dev/null +++ b/docs/developer-guide.rst @@ -0,0 +1,8 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. + +Developer Guide +=============== + +This document provides a quickstart for developers of the NF OAM Adopter. \ No newline at end of file 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..49d12eb --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,21 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. + +.. _nf-oam-adopter: + +============== +NF OAM Adopter +============== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + overview.rst + user-guide.rst + developer-guide.rst + deployment-guide.rst + release-notes.rst + +* :ref:`search` diff --git a/docs/overview.rst b/docs/overview.rst new file mode 100644 index 0000000..88a0a1f --- /dev/null +++ b/docs/overview.rst @@ -0,0 +1,8 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. + +Overview +======== + +This document provides an overview of the NF OAM Adopter. \ No newline at end of file diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 0000000..4912fe7 --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,10 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. + +============= +Release-Notes +============= + + +This document provides the release notes for the release of the NF OAM Adopter. \ No newline at end of file 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/docs/user-guide.rst b/docs/user-guide.rst new file mode 100644 index 0000000..cd389ba --- /dev/null +++ b/docs/user-guide.rst @@ -0,0 +1,8 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. + +User Guide +========== + +This document provides a quickstart for users of the NF OAM Adopter. \ No newline at end of file diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..2705e16 --- /dev/null +++ b/tox.ini @@ -0,0 +1,37 @@ +# ================================================================================== +# Copyright (c) 2020 Nordix +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# ================================================================================== + +# documentation only +[tox] +minversion = 2.0 +envlist = + docs, + docs-linkcheck, +skipsdist = true + +[testenv:docs] +basepython = python3 +deps = -r{toxinidir}/docs/requirements-docs.txt + +commands = + sphinx-build -W -b html -n -d {envtmpdir}/docs/doctrees ./docs/ {toxinidir}/docs/_build/html + echo "Generated docs available in {toxinidir}/docs/_build/html" +whitelist_externals = echo + +[testenv:docs-linkcheck] +basepython = python3 +deps = -r{toxinidir}/docs/requirements-docs.txt +commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck