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.

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

Install read_the_docs theme in .readthedocs.yaml #2029

Merged
merged 2 commits into from
Oct 24, 2023
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
8 changes: 4 additions & 4 deletions build/templates/.readthedocs.yaml.mako
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ formats:
- epub
- pdf

# Optionally declare the Python requirements required to build your docs
# Declare the Python requirements required to build your docs
## TODO(ni-jfitzger): Create requirements file for docs to make builds reproducible. See https://github.com/ni/nimi-python/issues/1968
## Note: Our nimi-python readthedocs project used the defaults here: https://docs.readthedocs.io/en/stable/build-default-versions.html#external-dependencies
# python:
# install:
# - requirements: docs/requirements.txt
python:
install:
- requirements: docs/requirements.txt
8 changes: 4 additions & 4 deletions docs/nidcpower/.readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ formats:
- epub
- pdf

# Optionally declare the Python requirements required to build your docs
# python:
# install:
# - requirements: docs/requirements.txt
# Declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
8 changes: 4 additions & 4 deletions docs/nidigital/.readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ formats:
- epub
- pdf

# Optionally declare the Python requirements required to build your docs
# python:
# install:
# - requirements: docs/requirements.txt
# Declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
8 changes: 4 additions & 4 deletions docs/nidmm/.readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ formats:
- epub
- pdf

# Optionally declare the Python requirements required to build your docs
# python:
# install:
# - requirements: docs/requirements.txt
# Declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
8 changes: 4 additions & 4 deletions docs/nifgen/.readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ formats:
- epub
- pdf

# Optionally declare the Python requirements required to build your docs
# python:
# install:
# - requirements: docs/requirements.txt
# Declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
8 changes: 4 additions & 4 deletions docs/nimodinst/.readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ formats:
- epub
- pdf

# Optionally declare the Python requirements required to build your docs
# python:
# install:
# - requirements: docs/requirements.txt
# Declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
8 changes: 4 additions & 4 deletions docs/niscope/.readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ formats:
- epub
- pdf

# Optionally declare the Python requirements required to build your docs
# python:
# install:
# - requirements: docs/requirements.txt
# Declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
8 changes: 4 additions & 4 deletions docs/nise/.readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ formats:
- epub
- pdf

# Optionally declare the Python requirements required to build your docs
# python:
# install:
# - requirements: docs/requirements.txt
# Declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
8 changes: 4 additions & 4 deletions docs/niswitch/.readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ formats:
- epub
- pdf

# Optionally declare the Python requirements required to build your docs
# python:
# install:
# - requirements: docs/requirements.txt
# Declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
8 changes: 4 additions & 4 deletions docs/nitclk/.readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ formats:
- epub
- pdf

# Optionally declare the Python requirements required to build your docs
# python:
# install:
# - requirements: docs/requirements.txt
# Declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
4 changes: 4 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# This isn't a full-fledged requirements file, yet. It's just a single unpinned dependency that we needed to fix our documentation builds.
# TODO(ni-jfitzger): Create requirements file for docs to make builds reproducible. See https://github.com/ni/nimi-python/issues/1968
# Note: Our nimi-python readthedocs project used the defaults here: https://docs.readthedocs.io/en/stable/build-default-versions.html#external-dependencies
sphinx_rtd_theme