From 011b190203d8082a53a7befba9a75a9c370fd346 Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Tue, 24 Oct 2023 08:32:22 -0500 Subject: [PATCH 1/2] Install read_the_docs theme in .readthedocs.yaml --- build/templates/.readthedocs.yaml.mako | 3 +++ docs/nidcpower/.readthedocs.yaml | 3 +++ docs/nidigital/.readthedocs.yaml | 3 +++ docs/nidmm/.readthedocs.yaml | 3 +++ docs/nifgen/.readthedocs.yaml | 3 +++ docs/nimodinst/.readthedocs.yaml | 3 +++ docs/niscope/.readthedocs.yaml | 3 +++ docs/nise/.readthedocs.yaml | 3 +++ docs/niswitch/.readthedocs.yaml | 3 +++ docs/nitclk/.readthedocs.yaml | 3 +++ 10 files changed, 30 insertions(+) diff --git a/build/templates/.readthedocs.yaml.mako b/build/templates/.readthedocs.yaml.mako index 3995569c8..9f9d8867e 100644 --- a/build/templates/.readthedocs.yaml.mako +++ b/build/templates/.readthedocs.yaml.mako @@ -58,3 +58,6 @@ formats: # python: # install: # - requirements: docs/requirements.txt +python: + install: + - sphinx-rtd-theme diff --git a/docs/nidcpower/.readthedocs.yaml b/docs/nidcpower/.readthedocs.yaml index 6ddf4326c..403997e3e 100644 --- a/docs/nidcpower/.readthedocs.yaml +++ b/docs/nidcpower/.readthedocs.yaml @@ -49,3 +49,6 @@ formats: # python: # install: # - requirements: docs/requirements.txt +python: + install: + - sphinx-rtd-theme diff --git a/docs/nidigital/.readthedocs.yaml b/docs/nidigital/.readthedocs.yaml index 78d424af5..e5663074a 100644 --- a/docs/nidigital/.readthedocs.yaml +++ b/docs/nidigital/.readthedocs.yaml @@ -49,3 +49,6 @@ formats: # python: # install: # - requirements: docs/requirements.txt +python: + install: + - sphinx-rtd-theme diff --git a/docs/nidmm/.readthedocs.yaml b/docs/nidmm/.readthedocs.yaml index b9cb50d33..549422157 100644 --- a/docs/nidmm/.readthedocs.yaml +++ b/docs/nidmm/.readthedocs.yaml @@ -49,3 +49,6 @@ formats: # python: # install: # - requirements: docs/requirements.txt +python: + install: + - sphinx-rtd-theme diff --git a/docs/nifgen/.readthedocs.yaml b/docs/nifgen/.readthedocs.yaml index 18118ab79..26365048b 100644 --- a/docs/nifgen/.readthedocs.yaml +++ b/docs/nifgen/.readthedocs.yaml @@ -49,3 +49,6 @@ formats: # python: # install: # - requirements: docs/requirements.txt +python: + install: + - sphinx-rtd-theme diff --git a/docs/nimodinst/.readthedocs.yaml b/docs/nimodinst/.readthedocs.yaml index c3c16f748..84bbc3a79 100644 --- a/docs/nimodinst/.readthedocs.yaml +++ b/docs/nimodinst/.readthedocs.yaml @@ -49,3 +49,6 @@ formats: # python: # install: # - requirements: docs/requirements.txt +python: + install: + - sphinx-rtd-theme diff --git a/docs/niscope/.readthedocs.yaml b/docs/niscope/.readthedocs.yaml index 58499e06f..f2e61c96f 100644 --- a/docs/niscope/.readthedocs.yaml +++ b/docs/niscope/.readthedocs.yaml @@ -49,3 +49,6 @@ formats: # python: # install: # - requirements: docs/requirements.txt +python: + install: + - sphinx-rtd-theme diff --git a/docs/nise/.readthedocs.yaml b/docs/nise/.readthedocs.yaml index 722de9133..d00fec9d2 100644 --- a/docs/nise/.readthedocs.yaml +++ b/docs/nise/.readthedocs.yaml @@ -49,3 +49,6 @@ formats: # python: # install: # - requirements: docs/requirements.txt +python: + install: + - sphinx-rtd-theme diff --git a/docs/niswitch/.readthedocs.yaml b/docs/niswitch/.readthedocs.yaml index 96c691d4c..908b731af 100644 --- a/docs/niswitch/.readthedocs.yaml +++ b/docs/niswitch/.readthedocs.yaml @@ -49,3 +49,6 @@ formats: # python: # install: # - requirements: docs/requirements.txt +python: + install: + - sphinx-rtd-theme diff --git a/docs/nitclk/.readthedocs.yaml b/docs/nitclk/.readthedocs.yaml index e5bddcd43..8b34b65a2 100644 --- a/docs/nitclk/.readthedocs.yaml +++ b/docs/nitclk/.readthedocs.yaml @@ -49,3 +49,6 @@ formats: # python: # install: # - requirements: docs/requirements.txt +python: + install: + - sphinx-rtd-theme From 82f80180c5a607224f6fff2a5710983ada648dea Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Tue, 24 Oct 2023 09:29:01 -0500 Subject: [PATCH 2/2] Attempt 2 - add requirements file (kind of) --- build/templates/.readthedocs.yaml.mako | 7 ++----- docs/nidcpower/.readthedocs.yaml | 7 ++----- docs/nidigital/.readthedocs.yaml | 7 ++----- docs/nidmm/.readthedocs.yaml | 7 ++----- docs/nifgen/.readthedocs.yaml | 7 ++----- docs/nimodinst/.readthedocs.yaml | 7 ++----- docs/niscope/.readthedocs.yaml | 7 ++----- docs/nise/.readthedocs.yaml | 7 ++----- docs/niswitch/.readthedocs.yaml | 7 ++----- docs/nitclk/.readthedocs.yaml | 7 ++----- docs/requirements.txt | 4 ++++ 11 files changed, 24 insertions(+), 50 deletions(-) create mode 100644 docs/requirements.txt diff --git a/build/templates/.readthedocs.yaml.mako b/build/templates/.readthedocs.yaml.mako index 9f9d8867e..0dd08faf2 100644 --- a/build/templates/.readthedocs.yaml.mako +++ b/build/templates/.readthedocs.yaml.mako @@ -52,12 +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: - - sphinx-rtd-theme + - requirements: docs/requirements.txt diff --git a/docs/nidcpower/.readthedocs.yaml b/docs/nidcpower/.readthedocs.yaml index 403997e3e..dcd41d297 100644 --- a/docs/nidcpower/.readthedocs.yaml +++ b/docs/nidcpower/.readthedocs.yaml @@ -45,10 +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: - - sphinx-rtd-theme + - requirements: docs/requirements.txt diff --git a/docs/nidigital/.readthedocs.yaml b/docs/nidigital/.readthedocs.yaml index e5663074a..4aee39a79 100644 --- a/docs/nidigital/.readthedocs.yaml +++ b/docs/nidigital/.readthedocs.yaml @@ -45,10 +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: - - sphinx-rtd-theme + - requirements: docs/requirements.txt diff --git a/docs/nidmm/.readthedocs.yaml b/docs/nidmm/.readthedocs.yaml index 549422157..083b682cb 100644 --- a/docs/nidmm/.readthedocs.yaml +++ b/docs/nidmm/.readthedocs.yaml @@ -45,10 +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: - - sphinx-rtd-theme + - requirements: docs/requirements.txt diff --git a/docs/nifgen/.readthedocs.yaml b/docs/nifgen/.readthedocs.yaml index 26365048b..f0502718c 100644 --- a/docs/nifgen/.readthedocs.yaml +++ b/docs/nifgen/.readthedocs.yaml @@ -45,10 +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: - - sphinx-rtd-theme + - requirements: docs/requirements.txt diff --git a/docs/nimodinst/.readthedocs.yaml b/docs/nimodinst/.readthedocs.yaml index 84bbc3a79..8b753c841 100644 --- a/docs/nimodinst/.readthedocs.yaml +++ b/docs/nimodinst/.readthedocs.yaml @@ -45,10 +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: - - sphinx-rtd-theme + - requirements: docs/requirements.txt diff --git a/docs/niscope/.readthedocs.yaml b/docs/niscope/.readthedocs.yaml index f2e61c96f..25f77890b 100644 --- a/docs/niscope/.readthedocs.yaml +++ b/docs/niscope/.readthedocs.yaml @@ -45,10 +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: - - sphinx-rtd-theme + - requirements: docs/requirements.txt diff --git a/docs/nise/.readthedocs.yaml b/docs/nise/.readthedocs.yaml index d00fec9d2..055056932 100644 --- a/docs/nise/.readthedocs.yaml +++ b/docs/nise/.readthedocs.yaml @@ -45,10 +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: - - sphinx-rtd-theme + - requirements: docs/requirements.txt diff --git a/docs/niswitch/.readthedocs.yaml b/docs/niswitch/.readthedocs.yaml index 908b731af..bc65e17ab 100644 --- a/docs/niswitch/.readthedocs.yaml +++ b/docs/niswitch/.readthedocs.yaml @@ -45,10 +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: - - sphinx-rtd-theme + - requirements: docs/requirements.txt diff --git a/docs/nitclk/.readthedocs.yaml b/docs/nitclk/.readthedocs.yaml index 8b34b65a2..a0bb8bf60 100644 --- a/docs/nitclk/.readthedocs.yaml +++ b/docs/nitclk/.readthedocs.yaml @@ -45,10 +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: - - sphinx-rtd-theme + - requirements: docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 000000000..5f227a6f2 --- /dev/null +++ b/docs/requirements.txt @@ -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 \ No newline at end of file