...
If you have questions about this process or need help, please contact the O-RAN-SC Documentation Project Technical Lead, weichen ni (niweichen@chinamobile.com)
Note: please be free to add Weichen Ni to you doc patch reviewer if you have any uncertainty.
Step 1: Add files to your-repo root
...
| No Format |
|---|
tox -e docs,docs-linkcheck ### Possible/typical error message in the output // fix by fixing the underlying RST document Warning, treated as error: /home/fedora/tmp/doci/aaa/docs/index.rst:23:toctree contains reference to document 'installation-guides' that doesn't have a title: no link will be generated ERROR: InvocationError for command '/home/fedora/tmp/doci/aaa/.tox/docs-linkcheck/bin/sphinx-build -W -b linkcheck -d /home/...(exited with code 2) |
Step 4: Add a link to your-repo documentation (this section output error, please do not do this at the moment)
4.1 Clone the doc area:
| No Format |
|---|
git clone "https://gerrit.o-ran-sc.org/r/a/doc" |
4.2 Add a mapping from key to URL in the conf.py file, for example:
...