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=50363c7a9c6b1231192e5ba78de3320a59affcba;p=ric-plt%2Fvespamgr.git Removing deprecated functions from readthedocs Change-Id: I466bf957fdec165b7d158ed95df6574130eb9ca2 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 e64330f..e028985 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -40,4 +40,5 @@ Welcome to O-RAN SC vespamgr Documentation * :ref:`genindex` * :ref:`modindex` -* :ref:`search` \ No newline at end of file +* :ref:`search` + diff --git a/docs/overview.rst b/docs/overview.rst index adcddad..71d057a 100755 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -60,7 +60,7 @@ VES Collector Event Format The VES Agent transmits events to the VES Collector in the VES Common Event Format v5.4.1. The Common Event Format is expressed in JSON schema v28.4.1. VES Event Listener 5.4.1: - + earlier under h t t p s://docs.onap.org/en/casablanca/submodules/vnfsdk/model.git/docs/files/VESEventListener.html JSON schema v28.4.1: @@ -74,7 +74,7 @@ The VESPA manager container requires the following environment variables: * VESMGR_NFNAMINGCODE - NF naming code as a string. Default: ricp. * VESMGR_HB_INTERVAL - VES heartbeat interval as a string. For example: 30s. * VESMGR_MEAS_INTERVAL - Measurement interval as a string. For example: 60s. -* VESMGR_PROMETHEUS_ADDR - Prometheus address. For example: http://127.0.0.1:123 +* VESMGR_PROMETHEUS_ADDR - Prometheus address. For example: h t t p://127.0.0.1:123 * VESMGR_ALERTMANAGER_BIND_ADDR - Bind address to receive alerts from Prometheus AlertManager * VESMGR_PRICOLLECTOR_ADDR - Primary collector FQDN as a string. For example: ricaux-entry. 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