tox.ini

   1 #==================================================================================
   2 #    Copyright (c) 2022 Samsung
   3
   4 #    Licensed under the Apache License, Version 2.0 (the "License");
   5 #    you may not use this file except in compliance with the License.
   6 #    You may obtain a copy of the License at
   7
   8 #    #http://www.apache.org/licenses/LICENSE-2.0
   9
  10 #    Unless required by applicable law or agreed to in writing, software
  11 #    distributed under the License is distributed on an "AS IS" BASIS,
  12 #    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 #    See the License for the specific language governing permissions and
  14 #    limitations under the License.
  15
  16 #    This source code is part of the near-RT RIC (RAN Intelligent Controller)
  17 #    platform project (RICP).
  18 #==================================================================================
  19
  20
  21 # Docs
  22 [tox]
  23 minversion = 2.0
  24 envlist =
  25     docs,
  26     docs-linkcheck,
  27
  28 skipsdist = true
  29
  30
  31 # verbatim as asked for by the docs instructions: https://wiki.o-ran-sc.org/display/DOC/Configure+Repo+for+Documentation
  32 [testenv:docs]
  33 basepython = python3
  34 deps =
  35     sphinx
  36     sphinx-rtd-theme
  37     sphinxcontrib-httpdomain
  38     recommonmark
  39     lfdocs-conf
  40     urllib3~=1.26.15
  41
  42 commands =
  43     sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  44     echo "Generated docs available in {toxinidir}/docs/_build/html"
  45 allowlist_externals = echo
  46
  47 [testenv:docs-linkcheck]
  48 basepython = python3
  49 deps = sphinx
  50        sphinx-rtd-theme
  51        sphinxcontrib-httpdomain
  52        recommonmark
  53        lfdocs-conf
  54        urllib3~=1.26.15
  55 commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck