...
Create or extend a file in the root of your repostory called tox.ini with the following content:.
Please note that Python projects must not use all entries shown here. The entry "skipsdist = true" is only appropriate if the project has no setup.py file that defines how to build distributions.
| No Format |
|---|
# documentation only
[tox]
minversion = 2.0
envlist =
docs,
docs-linkcheck,
skipsdist = true
[testenv:docs]
basepython = python3
deps =
sphinx
sphinx-rtd-theme
sphinxcontrib-httpdomain
recommonmark
lfdocs-conf
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
[testenv:docs-linkcheck]
basepython = python3
deps = sphinx
sphinx-rtd-theme
sphinxcontrib-httpdomain
recommonmark
lfdocs-conf
commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck |
...
2.2 Create an image file logo.png in the new docs/_static/ directory. Here's a good source for the image:
...
| No Format |
|---|
from docs_conf.conf import *
linkcheck_ignore = [
'http://localhost.*',
'http://127.0.0.1.*',
'https://gerrit.o-ran-sc.org.*'
] |
2.4 Create file docs/conf.yaml with the following content, but be sure to use your project name, not "your-repo":
| No Format |
|---|
--- project_cfg: oran project: your-repo |
2.5 Create an image file docs/favicon.ico in the docs/ directory. Herehere's a good source for the icon:
2.6 Create file docs/requirements-docs.txt with exactly the following content:
...