...
| 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 |
Step
...
2: Add files to your-repo/docs
In these steps you will create files in the "docs" subfolder of your repository. Please note that "docs" is a magic string, the directory name must be exactly that. Please use templates from the DOC area to create basic documentation files like "index.rst" and so on.
2.1 Make an empty directory "_static"
| No Format |
|---|
cd docs mkdir _static |
2.2 Create an image file logo.png in the new _static directory. Here's a good source for the image:
2.3 Create file conf.py with exactly the following content:
| No Format |
|---|
from docs_conf.conf import *
linkcheck_ignore = [
'http://localhost.*',
'http://127.0.0.1.*',
'https://gerrit.o-ran-sc.org.*'
] |
2.3 4 Create file 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 favicon.ico in the docs/ directory. Here's a good source for the icon:
2.6 .4 Create file requirements-docs.txt with exactly the following content:
| No Format |
|---|
sphinx sphinx-rtd-theme sphinxcontrib-httpdomain recommonmark lfdocs-conf |
Step
...
3: Add a link to your-repo documentation
3.1 Clone the doc area:
| No Format |
|---|
git clone "https://gerrit.o-ran-sc.org/r/doc" |
...
| No Format |
|---|
* :doc:`Your Project <your-repo:index> |
Step
...
4: Test
Edit a file in your docs/ area, commit the file to git and push your commit to Gerrit for review. You should see a documentation build job start.