blob: 586b1cc3e5acb837951bfe97811ee9224d2c426d [file] [log] [blame]
naman.guptab37f3022022-12-12 17:34:31 +05301#==================================================================================
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]
23minversion = 2.0
24envlist =
25 docs,
26 docs-linkcheck,
27
28skipsdist = 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]
33basepython = python3
34deps =
35 sphinx
36 sphinx-rtd-theme
37 sphinxcontrib-httpdomain
38 recommonmark
39 lfdocs-conf
40
41commands =
42 sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
43 echo "Generated docs available in {toxinidir}/docs/_build/html"
44whitelist_externals = echo
45
46[testenv:docs-linkcheck]
47basepython = python3
48deps = sphinx
49 sphinx-rtd-theme
50 sphinxcontrib-httpdomain
51 recommonmark
52 lfdocs-conf
53commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck