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:
No Format |
---|
---
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 file conf.py with the following content:
...
Page moved to the DOC space: Configure Repo for Documentation