Skip to content

Readthedocs integration #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Alek050 merged 3 commits into from
Mar 12, 2025
Merged

Readthedocs integration #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
18d1d3a
readthedocs shit
Alek050 Mar 12, 2025
d6fe59d
readthedocs.yml
Alek050 Mar 12, 2025
ad53cbc
resolved merge conflicts
Alek050 Mar 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build_jb.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ jobs:
pip install jupyter-book

- name: Build documentation (only on macos-latest)
run: jupyter-book build practicals_jn_book --all
run: jupyter-book build practicals_jn_book --all -W
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,4 +177,5 @@ cython_debug/
.DS_Store

# jupyter-book
practicals_jn_book/_build/*
practicals_jn_book/_build
practicals_jn_book/conf.py
18 changes: 18 additions & 0 deletions readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
version: 2

# Set the version of Python and other tools you might need
build:
os: macos-latest
tools:
python: "3.12"
jobs:
pre_build:
- "jupyter-book config sphinx practicals_jn_book/"

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

formats:
- pdf
- epub