Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 1 addition & 3 deletions .github/workflows/sphinx.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ on:
- "docs/**"
- "README.md"
- ".readthedocs.yaml"
- "requirements-docs.txt"
push:
branches:
- main
Expand All @@ -21,7 +20,6 @@ on:
- "docs/**"
- "README.md"
- ".readthedocs.yaml"
- "requirements-docs.txt"
workflow_dispatch:

jobs:
Expand All @@ -44,7 +42,7 @@ jobs:
- name: Install Doc Dependencies 📦
run: |
pip install --upgrade pip
pip install --upgrade -r requirements-docs.txt
pip install --upgrade -r docs/requirements.txt

- name: Build Documentation 📖
run: make docs
Expand Down
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ sphinx:
# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: requirements-docs.txt
- requirements: docs/requirements.txt
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs folder is self-contained, so it's easier to store this file there.

2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]

# File above was generated using sphinx 4.3.2 with this command:
# File above was generated using sphinx 4.5.0 with this command:
# sphinx-quickstart --project "docker-stacks" --author "Project Jupyter" -v "latest" -r "latest" -l en --no-sep --no-makefile --no-batchfile
# These are custom options for this project

Expand Down
8 changes: 4 additions & 4 deletions requirements-docs.txt → docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# ReadTheDocs environment contains old package versions preinstalled
# So, to ensure we have modern packages, we pin minimum versions of the packages we need
docutils>=0.17
myst-parser>=0.16.1
sphinx>=4.4.0
sphinx-book-theme>=0.3.2
docutils>=0.17.1
myst-parser>=0.18.0
sphinx>=4.5.0
sphinx-book-theme>=0.3.3
sphinx-copybutton>=0.5.0