From de24f9b2f51cde093856291eced784fa48b0a042 Mon Sep 17 00:00:00 2001 From: "Sean P. Goggins" Date: Mon, 30 Oct 2023 12:19:10 -0500 Subject: [PATCH 1/5] fixing read the docs dot io issues Signed-off-by: Sean P. Goggins --- .readthedocs.yml | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 .readthedocs.yml diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000000..aa437d63ff --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,29 @@ +#SPDX-License-Identifier: MIT +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/source/conf.py + +# Build documentation with MkDocs +#mkdocs: +# configuration: mkdocs.yml + +# Optionally build your docs in additional formats such as PDF and ePub +formats: all + +# Optionally set the version of Python and requirements required to build your docs +python: + version: 3.8 + install: + - method: pip + path: . + extra_requirements: + - dev + - method: setuptools + path: . From 0750aca330d4fe750dace1c5fb94ba0cce25fdbf Mon Sep 17 00:00:00 2001 From: "Sean P. Goggins" Date: Mon, 30 Oct 2023 12:23:32 -0500 Subject: [PATCH 2/5] fixing readthe docs dot io configuration Signed-off-by: Sean P. Goggins --- .readthedocs.yml | 7 ++++++- readthedocs.yml | 7 ++++++- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index aa437d63ff..17139560e0 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -19,7 +19,7 @@ formats: all # Optionally set the version of Python and requirements required to build your docs python: - version: 3.8 + version: 3.10 install: - method: pip path: . @@ -27,3 +27,8 @@ python: - dev - method: setuptools path: . + + build: + os: ubuntu-22.04 + tools: + python:3.10 diff --git a/readthedocs.yml b/readthedocs.yml index aa437d63ff..17139560e0 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -19,7 +19,7 @@ formats: all # Optionally set the version of Python and requirements required to build your docs python: - version: 3.8 + version: 3.10 install: - method: pip path: . @@ -27,3 +27,8 @@ python: - dev - method: setuptools path: . + + build: + os: ubuntu-22.04 + tools: + python:3.10 From d537002ef0acdfd0b4538d9cfe3d0ecd6f02c1f4 Mon Sep 17 00:00:00 2001 From: "Sean P. Goggins" Date: Mon, 30 Oct 2023 12:28:15 -0500 Subject: [PATCH 3/5] fixing readthedocs.io build issues Signed-off-by: Sean P. Goggins --- .readthedocs.yml | 30 +++++++++++++++++------------- readthedocs.yml | 30 +++++++++++++++++------------- 2 files changed, 34 insertions(+), 26 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 17139560e0..436e039b96 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -5,6 +5,10 @@ # Required version: 2 +build: + os: ubuntu-22.04 # <- add this line + tools: + python: "3.10" # Build documentation in the docs/ directory with Sphinx sphinx: @@ -18,17 +22,17 @@ sphinx: formats: all # Optionally set the version of Python and requirements required to build your docs -python: - version: 3.10 - install: - - method: pip - path: . - extra_requirements: - - dev - - method: setuptools - path: . +#python: +# version: 3.10 +# install: +# - method: pip +# path: . +# extra_requirements: +# - dev +# - method: setuptools +# path: . - build: - os: ubuntu-22.04 - tools: - python:3.10 +# build: +# os: ubuntu-22.04 +# tools: +# python:3.10 diff --git a/readthedocs.yml b/readthedocs.yml index 17139560e0..436e039b96 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -5,6 +5,10 @@ # Required version: 2 +build: + os: ubuntu-22.04 # <- add this line + tools: + python: "3.10" # Build documentation in the docs/ directory with Sphinx sphinx: @@ -18,17 +22,17 @@ sphinx: formats: all # Optionally set the version of Python and requirements required to build your docs -python: - version: 3.10 - install: - - method: pip - path: . - extra_requirements: - - dev - - method: setuptools - path: . +#python: +# version: 3.10 +# install: +# - method: pip +# path: . +# extra_requirements: +# - dev +# - method: setuptools +# path: . - build: - os: ubuntu-22.04 - tools: - python:3.10 +# build: +# os: ubuntu-22.04 +# tools: +# python:3.10 From 163f5cd0385b4de9643ecb6358a415ae00f538c9 Mon Sep 17 00:00:00 2001 From: "Sean P. Goggins" Date: Mon, 30 Oct 2023 12:36:55 -0500 Subject: [PATCH 4/5] readthe docs dot io Signed-off-by: Sean P. Goggins --- .readthedocs.yml | 18 +++++++++--------- readthedocs.yml | 18 +++++++++--------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 436e039b96..bd50d7163f 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -22,15 +22,15 @@ sphinx: formats: all # Optionally set the version of Python and requirements required to build your docs -#python: -# version: 3.10 -# install: -# - method: pip -# path: . -# extra_requirements: -# - dev -# - method: setuptools -# path: . +python: + version: 3.10 + install: + - method: pip + path: . + extra_requirements: + - dev + - method: setuptools + path: . # build: # os: ubuntu-22.04 diff --git a/readthedocs.yml b/readthedocs.yml index 436e039b96..bd50d7163f 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -22,15 +22,15 @@ sphinx: formats: all # Optionally set the version of Python and requirements required to build your docs -#python: -# version: 3.10 -# install: -# - method: pip -# path: . -# extra_requirements: -# - dev -# - method: setuptools -# path: . +python: + version: 3.10 + install: + - method: pip + path: . + extra_requirements: + - dev + - method: setuptools + path: . # build: # os: ubuntu-22.04 From 317fe421db909f9600343970cad93c9cf5a13038 Mon Sep 17 00:00:00 2001 From: "Sean P. Goggins" Date: Mon, 30 Oct 2023 12:38:05 -0500 Subject: [PATCH 5/5] rtd.io Signed-off-by: Sean P. Goggins --- .readthedocs.yml | 1 - readthedocs.yml | 1 - 2 files changed, 2 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index bd50d7163f..3b0e387327 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -23,7 +23,6 @@ formats: all # Optionally set the version of Python and requirements required to build your docs python: - version: 3.10 install: - method: pip path: . diff --git a/readthedocs.yml b/readthedocs.yml index bd50d7163f..3b0e387327 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -23,7 +23,6 @@ formats: all # Optionally set the version of Python and requirements required to build your docs python: - version: 3.10 install: - method: pip path: .