From: czichy Date: Fri, 1 Sep 2023 06:24:01 +0000 (+0300) Subject: Removing deprecated functions from readthedocs X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=205853ce6e0d8eadb8a2d85e6b48b9a80bdf69b3;p=ric-plt%2Ftracelibgo.git Removing deprecated functions from readthedocs Change-Id: Icc8c14f489409b0979a6f40e4b04b3866940bdbf Signed-off-by: czichy --- diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 095222a..864f935 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,14 +1,19 @@ --- +# .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 + os: "ubuntu-22.04" + tools: + python: "3.7" python: - version: 3.7 install: - requirements: docs/requirements-docs.txt diff --git a/docs/index.rst b/docs/index.rst index b64de39..1f44430 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,46 +1,46 @@ -.. -.. Copyright (c) 2019 AT&T Intellectual Property. -.. -.. Copyright (c) 2019 Nokia. -.. -.. -.. Licensed under the Creative Commons Attribution 4.0 International -.. -.. Public License (the "License"); you may not use this file except -.. -.. in compliance with the License. You may obtain a copy of the License at -.. -.. -.. https://creativecommons.org/licenses/by/4.0/ -.. -.. -.. Unless required by applicable law or agreed to in writing, documentation -.. -.. 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. -.. -.. This source code is part of the near-RT RIC (RAN Intelligent Controller) -.. platform project (RICP). -.. - -Welcome to O-RAN SC tracelibgo Documentation -============================================ - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - overview.rst - developer-guide.rst - release-notes.rst - - - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +.. +.. Copyright (c) 2019 AT&T Intellectual Property. +.. +.. Copyright (c) 2019 Nokia. +.. +.. +.. Licensed under the Creative Commons Attribution 4.0 International +.. +.. Public License (the "License"); you may not use this file except +.. +.. in compliance with the License. You may obtain a copy of the License at +.. +.. +.. https://creativecommons.org/licenses/by/4.0/ +.. +.. +.. Unless required by applicable law or agreed to in writing, documentation +.. +.. 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. +.. +.. This source code is part of the near-RT RIC (RAN Intelligent Controller) +.. platform project (RICP). +.. + +Welcome to O-RAN SC tracelibgo Documentation +============================================ + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + overview.rst + developer-guide.rst + release-notes.rst + + + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/tox.ini b/tox.ini index ac38348..18bbdaa 100644 --- a/tox.ini +++ b/tox.ini @@ -18,11 +18,12 @@ deps = sphinxcontrib-httpdomain recommonmark lfdocs-conf + urllib3~=1.26.15 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 +allowlist_externals = echo [testenv:docs-linkcheck] passenv = @@ -35,4 +36,5 @@ deps = sphinx sphinxcontrib-httpdomain recommonmark lfdocs-conf + urllib3~=1.26.15 commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck