josh/tutorial-template
Template
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Compare commits

merge into: josh:add-readthedocs-yaml
Branches Tags
josh:main josh:add-readthedocs-yaml
...
pull from: josh:main
Branches Tags
josh:main josh:add-readthedocs-yaml

4 Commits
add-readth ... main

Author SHA1 Message Date
Manuel Kaufmann
f594c40889 Merge pull request #53 from readthedocs/humitos/explicit-sphinx-conf 
Use a explicit `sphinx.configuration`
 2023-09-12 23:03:19 +02:00
Manuel Kaufmann
be76d782b0 Use a explicit sphinx.configuration 
Making this config explicit instead of realying on Read the Docs finding the
correct `conf.py` file.
 2023-09-07 18:50:42 +02:00
Eric Holscher
00dc2a70d1 Merge pull request #52 from readthedocs/humitos/config-requirements 
Use a YAML file and Python requirements
 2023-08-16 10:07:27 -08:00
Manuel Kaufmann
4dc74175cc Use a YAML file and Python requirements 
The `.readthedocs.yaml` file is now required.

Besdies, we are not installing the Read the Docs Sphinx theme by default.
Due to that, we need to manually install it via `requirements.txt`
 2023-08-16 17:17:20 +02:00
2 changed files with 15 additions and 0 deletions
Expand all files Collapse all files

13
.readthedocs.yaml Normal file
View File

@@ -0,0 +1,13 @@
version: "2"
build:
os: "ubuntu-22.04"
tools:
python: "3.10"
python:
install:
- requirements: docs/requirements.txt
sphinx:
configuration: docs/source/conf.py

2
docs/requirements.txt Normal file
View File

@@ -0,0 +1,2 @@
sphinx==7.1.2
sphinx-rtd-theme==1.3.0rc1