Versions Compared

Key

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

...

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 Make an empty directory "_static"

No Format
cd docsmkdir _static

2.2 Create file conf.py with exactly 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 3 Create file conf.yaml with the following content and , but be sure to use your project name, not "your-repo":

No Format
---
project_cfg: oran
project: your-repo

2.3 4 Create file requirements-docs.txt with exactly the following content:

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

...