Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Step 4: Add a link to your-repo documentation

34.1 Clone the doc area:

No Format
git clone "https://gerrit.o-ran-sc.org/r/doc"

34.2 Add a mapping from key to URL in the conf.py file, for example:

No Format
intersphinx_mapping['your-repo'] = ('https://o-ran-sc-doc.readthedocs.io/projects/o-ran-sc-your-repo/en/%s' % branch, None a

34.3 Add a link to your mapping key in an appropriate file such as index.rst, for example:

No Format
* :doc:`Your Project <your-repo:index>

Step

...

5: Test publication

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.