...
Note: please add weichen ni as a reviewer on all Gerrit doc changesets if you have any questions.
Configuration needed for your _repo/
Please use the automated setup process that is documented here:
https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/jjb/lf-rtdv3-jobs.html
If that process fails or you need to trouble-shoot problems, this page gives step by step details.
Manual Step 1: Add files to your-repo root
...
| No Format |
|---|
### 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 step output error, please do not do this at the moment, DOC team will handle this step.)
...
If everything correct, you will see a succeed or successful output after running 'tox -e docs,docs-linkcheck'.
It is the time to upload your change to gerrit. When you merged your change, you project docs will show on the page : https://readthedocs.org/projects/o-ran-sc-doc/. If you can scroll down, and you project name will display on the right.
Please let DOC teamweichen niknow when you complete Step 3, as the configuration work in your_repo is finished, DOC team will handle Step 4 and make your docs work.
DOC team will do the Step 4 in DOC repo! If you are not from OSC DOC project, please do not do this step.
Step 4: Add a link to your-repo documentation
4.1 Clone the doc area via ssh. (best to just go here and select the ssh option "https://gerrit.o-ran-sc.org/r/admin/repos/doc"
...