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:
Code Block |
---|
abc |
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
2.1 Create file conf.py with the following content:
No Format |
---|
from docs_conf.conf import *
linkcheck_ignore = [
'http://localhost.*',
'http://127.0.0.1.*',
'https://gerrit.o-ran-sc.org.*'
] |
2.2 Create file conf.yaml with the following content and your project name:
No Format |
---|
---
project_cfg: oran
project: your-repo |
2.3 Create file requirements-docs.txt with the following content:
...
Page moved to the DOC space: Configure Repo for Documentation