From 05ae651f50b27113d2c152665d1f0565a64c48e5 Mon Sep 17 00:00:00 2001 From: Anupam Sengupta Date: Mon, 19 Jun 2023 14:42:23 -0400 Subject: [PATCH 01/14] Added configuration for readthedocs.org --- .readthedocs.yaml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..b8c2f2b --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,22 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: doc/conf.py + +# We recommend specifying your dependencies to enable reproducible builds: +# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +# python: +# install: +# - requirements: docs/requirements.txt From ca604a2892df8071890269c1db6befb4a2ee9103 Mon Sep 17 00:00:00 2001 From: Anupam Sengupta Date: Mon, 19 Jun 2023 14:42:23 -0400 Subject: [PATCH 02/14] Added configuration for readthedocs.org --- .readthedocs.yaml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..b8c2f2b --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,22 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: doc/conf.py + +# We recommend specifying your dependencies to enable reproducible builds: +# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +# python: +# install: +# - requirements: docs/requirements.txt From 2aa138d15aba3939c24f7e6b56785fd656c512b5 Mon Sep 17 00:00:00 2001 From: Anupam Sengupta Date: Fri, 20 Dec 2024 00:40:16 -0500 Subject: [PATCH 03/14] Fix .readthedocs.yaml Configuration for readthedocs.org documentation. --- .readthedocs.yaml | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index b8c2f2b..e9751dc 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -5,18 +5,18 @@ # Required version: 2 -# Set the version of Python and other tools you might need +# Set the version of Ruby and other tools you might need build: os: ubuntu-22.04 tools: - python: "3.11" + ruby: "3.3" -# Build documentation in the docs/ directory with Sphinx -sphinx: - configuration: doc/conf.py - -# We recommend specifying your dependencies to enable reproducible builds: -# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -# python: -# install: -# - requirements: docs/requirements.txt +ruby: + install: + - gemfile: Gemfile + +commands: + - gem install bundler + - bundle install + - rake doc:yard + - cp -r doc $READTHEDOCS_OUTPUT/html From 1693cead5d69908c005c84287a4feb146e0b5a06 Mon Sep 17 00:00:00 2001 From: Anupam Sengupta Date: Fri, 20 Dec 2024 00:59:41 -0500 Subject: [PATCH 04/14] Removed the top-level `ruby` key in .readthedocs.yaml This is not supported. --- .readthedocs.yaml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e9751dc..a4143b4 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -10,10 +10,6 @@ build: os: ubuntu-22.04 tools: ruby: "3.3" - -ruby: - install: - - gemfile: Gemfile commands: - gem install bundler From d48e92e669d4afc9cf2f83d7094c9e931777e514 Mon Sep 17 00:00:00 2001 From: Anupam Sengupta Date: Fri, 20 Dec 2024 01:01:06 -0500 Subject: [PATCH 05/14] Fixed YAML indentation in .readthedocs.yaml --- .readthedocs.yaml | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index a4143b4..1c742b7 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,10 +9,9 @@ version: 2 build: os: ubuntu-22.04 tools: - ruby: "3.3" - -commands: - - gem install bundler - - bundle install - - rake doc:yard - - cp -r doc $READTHEDOCS_OUTPUT/html + ruby: "3.3" + commands: + - gem install bundler + - bundle install + - rake doc:yard + - cp -r doc $READTHEDOCS_OUTPUT/html From 216b193122f897cce9416580e98b5671458dd4fc Mon Sep 17 00:00:00 2001 From: Anupam Sengupta Date: Fri, 20 Dec 2024 01:05:12 -0500 Subject: [PATCH 06/14] Using Ruby 2.7 for .readthedocs.yaml --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 1c742b7..38f54df 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,7 @@ version: 2 build: os: ubuntu-22.04 tools: - ruby: "3.3" + ruby: "2.7" commands: - gem install bundler - bundle install From 67a21d8d3ff69895a0090359e0f23a550479a92f Mon Sep 17 00:00:00 2001 From: Anupam Sengupta Date: Fri, 20 Dec 2024 01:09:36 -0500 Subject: [PATCH 07/14] Reverted to Ruby 3.3 in .readthedocs.yaml This or "latest" are the only options. --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 38f54df..1c742b7 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,7 @@ version: 2 build: os: ubuntu-22.04 tools: - ruby: "2.7" + ruby: "3.3" commands: - gem install bundler - bundle install From 3f1e1a4ae9f792fac2f4f1e83df34060831af293 Mon Sep 17 00:00:00 2001 From: Anupam Sengupta Date: Fri, 20 Dec 2024 01:15:01 -0500 Subject: [PATCH 08/14] Specified the bundler version in .readthedocs.yaml --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 1c742b7..e76e24d 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -11,7 +11,7 @@ build: tools: ruby: "3.3" commands: - - gem install bundler + - gem install bundler -v 2.3 - bundle install - rake doc:yard - cp -r doc $READTHEDOCS_OUTPUT/html From a9923d044faa7ebf0cc750c11cef96f93ce49bc6 Mon Sep 17 00:00:00 2001 From: Anupam Sengupta Date: Fri, 20 Dec 2024 01:17:37 -0500 Subject: [PATCH 09/14] Run rake via bundle in the .readthedocs.yaml --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e76e24d..44a2fbe 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -13,5 +13,5 @@ build: commands: - gem install bundler -v 2.3 - bundle install - - rake doc:yard + - bundle exec rake doc:yard - cp -r doc $READTHEDOCS_OUTPUT/html From 1461f4b0e3ad51a377fcfc2299088d5b5839cf35 Mon Sep 17 00:00:00 2001 From: Anupam Sengupta Date: Fri, 20 Dec 2024 01:23:20 -0500 Subject: [PATCH 10/14] Create the output directory .readthedocs.yaml --- .readthedocs.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 44a2fbe..e5d6fdb 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -14,4 +14,5 @@ build: - gem install bundler -v 2.3 - bundle install - bundle exec rake doc:yard + - mkdir -p $READTHEDOCS_OUTPUT/html - cp -r doc $READTHEDOCS_OUTPUT/html From 7d4613e95c6eb44d7add6c2bdcdf06f44655e978 Mon Sep 17 00:00:00 2001 From: Anupam Sengupta Date: Fri, 20 Dec 2024 01:46:11 -0500 Subject: [PATCH 11/14] Display contents of the output file .readthedocs.yaml --- .readthedocs.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e5d6fdb..ba8c4ef 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -16,3 +16,4 @@ build: - bundle exec rake doc:yard - mkdir -p $READTHEDOCS_OUTPUT/html - cp -r doc $READTHEDOCS_OUTPUT/html + - ls -l $READTHEDOCS_OUTPUT/html From abadbdfea6b024e58c9d06fc4a5e77d35c276755 Mon Sep 17 00:00:00 2001 From: Anupam Sengupta Date: Fri, 20 Dec 2024 01:49:43 -0500 Subject: [PATCH 12/14] Copy contents of doc and not the folder itself .readthedocs.yaml --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index ba8c4ef..54ef241 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -15,5 +15,5 @@ build: - bundle install - bundle exec rake doc:yard - mkdir -p $READTHEDOCS_OUTPUT/html - - cp -r doc $READTHEDOCS_OUTPUT/html + - cp -r doc/ $READTHEDOCS_OUTPUT/html/ - ls -l $READTHEDOCS_OUTPUT/html From ce2113ba66221c65686479adb186878d60ce6882 Mon Sep 17 00:00:00 2001 From: Anupam Sengupta Date: Fri, 20 Dec 2024 01:55:01 -0500 Subject: [PATCH 13/14] Fixed for real this time .readthedocs.yaml --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 54ef241..1a70c3a 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -15,5 +15,5 @@ build: - bundle install - bundle exec rake doc:yard - mkdir -p $READTHEDOCS_OUTPUT/html - - cp -r doc/ $READTHEDOCS_OUTPUT/html/ + - cp -r doc/. $READTHEDOCS_OUTPUT/html/ - ls -l $READTHEDOCS_OUTPUT/html From 8bad5a3e004f375c3c09166066af410c8d587615 Mon Sep 17 00:00:00 2001 From: Anupam Sengupta Date: Fri, 20 Dec 2024 01:57:42 -0500 Subject: [PATCH 14/14] Removed the ls debug --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 1a70c3a..63a1dcd 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -16,4 +16,4 @@ build: - bundle exec rake doc:yard - mkdir -p $READTHEDOCS_OUTPUT/html - cp -r doc/. $READTHEDOCS_OUTPUT/html/ - - ls -l $READTHEDOCS_OUTPUT/html +