This page provides instructions for configuring your component's documentation area so the O-RAN-SC Jenkins will automatically build and deploy the material to https://o-ran-sc.readthedocs.io/en/latest/ upon change of any file within your docs/ directory.
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 add weichen ni as a reviewer on all Gerrit doc changesets if you have any questions.
Please use the automated setup process that is documented at 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
...
.
...
Note: please add weichen ni as a reviewer on all Gerrit doc changesets if you have any questions.
Step 1: Add files to your-repo root
...
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 via ssh. (best to just go here and select the ssh option "https://gerrit.o-ran-sc.org/r/admin/repos/doc"
I think your strange cloning is why you are having problems pushing reviews. are you not using git-review?
| No Format |
|---|
git clone "httpsssh://gerrit"lfid"@gerrit.o-ran-sc.org:29418/r/a/doc" |
4.2 Add a mapping from key to URL in the conf.py file, for example:
I think the Docs PTL should take care of the intersphinx mapping. Also each project should have at least one anchor in their docs/index.rst at a minimum. https://www.sphinx-doc.org/en/1.5/markup/inline.html#cross-referencing-arbitrary-locations
This probably explains how to set up the intersphinx mapping for subprojects the best, however. Once we move to the docs.o-ran-sc.org CNAME this will change, so personally I would just ask teams to focus on their own docs and worry about linking them to the index later.
I think the doc ptl should organize the main index page in any case.
$ grep -r portal-ric-dashboard .
./index.rst:* :doc:`RIC Dashboard <portal-ric-dashboard:index>`
./conf.py:intersphinx_mapping['portal-ric-dashboard'] = ('https://o-ran-sc-doc.readthedocs.io/projects/o-ran-sc-portal-ric-dashboard/en/%s' % branch, None)
| No Format |
|---|
intersphinx_mapping['your-repo'] = ('https://o-ran-sc-doc.readthedocs.io/projects/o-ran-sc-your-repo/en/%s' % branch, None a |
...