Page History

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-doc.readthedocs.io/en/latest/

Step 1: Add file your-repo/.readthedocs

Create a file in the root of your repository called .readthedocs.yaml (yes there's a leading dot) with the following content:

---
version: 2

formats:
  - htmlzip

build:
  image: latest

python:
  version: 3.7
  install:
    - requirements: docs/requirements-docs.txt

sphinx:
  configuration: docs/conf.py

Step 2: Configure your-repo/docs area

Create files in the "docs" subfolder of your repository.

2.1 Make an empty directory "_static"

...

sphinx
sphinx-rtd-theme
sphinxcontrib-httpdomain
recommonmark
lfdocs-conf

Step 3: Add a link to your-repo documentation

3.1 Clone the doc area:

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

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

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

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

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