Skip to content

Commit

Permalink
Merge pull request #5878 from mvieth/readthedocs_config
Browse files Browse the repository at this point in the history
Add readthedocs config files
  • Loading branch information
mvieth authored Nov 20, 2023
2 parents 84aa570 + c37d578 commit 0d123a4
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ Ubuntu | [![Status][ci-ubuntu-20.04]][ci-latest-build] <br> [!
Windows | [![Status][ci-windows-x86]][ci-latest-build] <br> [![Status][ci-windows-x64]][ci-latest-build] |
macOS | [![Status][ci-macos-12]][ci-latest-build] <br> [![Status][ci-macos-13]][ci-latest-build] |
Documentation | [![Status][ci-docs]][ci-latest-docs] |
Read the Docs | [![Documentation Status](https://readthedocs.org/projects/pcl-tutorials/badge/?version=master)](https://pcl.readthedocs.io/projects/tutorials/en/master/?badge=master) |

Community
---------
Expand Down
22 changes: 22 additions & 0 deletions doc/advanced/.readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.11"

sphinx:
configuration: doc/advanced/content/conf.py

formats:
- epub
- pdf

python:
install:
- requirements: doc/requirements.txt
22 changes: 22 additions & 0 deletions doc/tutorials/.readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.11"

sphinx:
configuration: doc/tutorials/content/conf.py

formats:
- epub
- pdf

python:
install:
- requirements: doc/requirements.txt

0 comments on commit 0d123a4

Please sign in to comment.