Skip to content

Commit 8b9b05b

Browse files
committed
docs: update readthedocs config
1 parent 85919af commit 8b9b05b

File tree

4 files changed

+25
-7
lines changed

4 files changed

+25
-7
lines changed

.readthedocs.yaml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Configuration on how ReadTheDocs (RTD) builds our documentation
2+
# ref: https://readthedocs.org/projects/repo2docker-service/
3+
# ref: https://docs.readthedocs.io/en/stable/config-file/v2.html
4+
#
5+
version: 2
6+
7+
sphinx:
8+
configuration: docs/source/conf.py
9+
10+
build:
11+
os: ubuntu-22.04
12+
tools:
13+
python: "3.10"
14+
15+
python:
16+
install:
17+
- requirements: docs/requirements.txt
18+
- method: pip
19+
path: .

docs/source/conf.py

+5-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@
33
# Add any Sphinx extension module names here, as strings. They can be
44
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
55
# ones.
6-
extensions = ["sphinx.ext.extlinks", "sphinxcontrib.autoprogram", "myst_parser"]
6+
extensions = [
7+
"myst_parser",
8+
"sphinx.ext.extlinks",
9+
"sphinxcontrib.autoprogram",
10+
]
711

812
extlinks = {
913
"issue": ("https://github.com/jupyterhub/repo2docker/issues/%s", "Issue #"),

docs/source/contributing/contributing.md

+1
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,7 @@ Then you are good to go!
187187
You can build and inspect the result of documentation changes locally.
188188

189189
```bash
190+
pip install -e .
190191
pip install -r docs/requirements.txt
191192

192193
cd docs/

readthedocs.yml

-6
This file was deleted.

0 commit comments

Comments
 (0)