Skip to content
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

Jump to bottom

Add sphinx_rtd_theme to docs dependencies #301

Merged
merged 10 commits into from
Sep 12, 2023
Merged

Add sphinx_rtd_theme to docs dependencies #301

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
0a889ee
Add sphinx_rtd_theme to docs dependencies
will-moore Aug 24, 2023
da4151d
Specify requirements.txt in .readthedocs.yml
will-moore Aug 25, 2023
fd682c8
Remove method: pip from rtd python.install
will-moore Aug 25, 2023
492b29c
Updating to match rtd tutorial template
will-moore Aug 25, 2023
14ee7e4
Add html_theme to conf.py
will-moore Aug 25, 2023
24a09e5
Add deps to requirements.txt based on rtd build errors
will-moore Aug 25, 2023
f1dbe72
Add deps to requirements.txt based on rtd build errors
will-moore Aug 25, 2023
9152f31
Add deps to requirements.txt based on rtd build errors
will-moore Aug 25, 2023
36f2b4d
Use sphinx-rtd-theme==1.3.0
will-moore Sep 12, 2023
17ee62a
Temp cap fsspec to avoid https://github.com/fsspec/filesystem_spec/pu…
will-moore Sep 12, 2023
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
5 changes: 2 additions & 3 deletions .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ version: 2
build:
os: ubuntu-20.04
tools:
python: "3.9"
python: "3.10"
# You can also specify other tool versions:
# nodejs: "16"
# rust: "1.55"
Expand All @@ -29,5 +29,4 @@ sphinx:
# Optionally declare the Python requirements required to build your docs
python:
install:
- method: pip
path: .
- requirements: docs/requirements.txt
7 changes: 7 additions & 0 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
sphinx==7.1.2
sphinx-rtd-theme==1.3.0rc1
Copy link
Member

Choose a reason for hiding this comment

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

Why did you pick the rc?

Copy link
Member Author

Choose a reason for hiding this comment

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

See 492b29c - I copied a template (link in the commit)

Copy link
Member

Choose a reason for hiding this comment

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

but you don't need the rc to get it to work

Copy link
Member Author

Choose a reason for hiding this comment

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

I wasn't taking any chances!
But OK, removed the rc now.

zarr
dask
numpy
scipy
scikit-image
4 changes: 4 additions & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"sphinx.ext.doctest",
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx_rtd_theme",
]

# use index.rst instead of contents.rst
Expand All @@ -28,3 +29,6 @@
"numpy": ("https://numpy.org/doc/stable/", None),
"zarr": ("https://zarr.readthedocs.io/en/stable/", None),
}

# https://github.com/readthedocs/sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
Loading