From 58b4ddd23d444278163304b1e6bf7b7a0689c85f Mon Sep 17 00:00:00 2001 From: Kip Hart <41959581+kip-hart@users.noreply.github.com> Date: Tue, 2 Jan 2024 09:10:34 -0800 Subject: [PATCH 1/7] Update conf.py --- docs/source/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/source/conf.py b/docs/source/conf.py index 78fe273..de69521 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -43,6 +43,7 @@ 'sphinx.ext.napoleon', 'sphinx.ext.mathjax', 'sphinx.ext.viewcode', + 'sphinx_rtd_theme', ] # Suppress "WARNING: unknown mimetype for ..." From bf9499b9eafae9d06603ac729ee9e406bb0891ff Mon Sep 17 00:00:00 2001 From: Kip Hart <41959581+kip-hart@users.noreply.github.com> Date: Tue, 2 Jan 2024 09:16:01 -0800 Subject: [PATCH 2/7] yml now consistent with sphinx_rtd_theme --- .readthedocs.yaml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index aca2edb..f04b5e3 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,9 +9,9 @@ formats: all # Set the version of Python and other tools you might need build: - os: ubuntu-22.04 + os: "ubuntu-22.04" tools: - python: "3.9" + python: "3.10" # Build documentation in the docs/ directory with Sphinx sphinx: @@ -20,3 +20,5 @@ sphinx: python: install: - requirements: docs/requirements.txt + - method: pip + path: . From 0e3e11977b387b93abab902cd07dfb8c1c754f5b Mon Sep 17 00:00:00 2001 From: Kip Hart <41959581+kip-hart@users.noreply.github.com> Date: Tue, 2 Jan 2024 09:20:27 -0800 Subject: [PATCH 3/7] Update requirements.txt docs/requirements consistent with sphinx_rtd_theme --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 6c5d5d4..a6760f7 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1 @@ -sphinx-rtd-theme +sphinx>=7.1,<7.2 From ad327b49ab4c4ac2ebbebb38c69de4d689ed7552 Mon Sep 17 00:00:00 2001 From: Kip Hart <41959581+kip-hart@users.noreply.github.com> Date: Tue, 2 Jan 2024 09:27:28 -0800 Subject: [PATCH 4/7] add back sphinx-rtd-theme to docs/requirements.txt --- docs/requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index a6760f7..1dfd006 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1,2 @@ sphinx>=7.1,<7.2 +sphinx-rtd-theme>=2.0 From 138983db6c7900cb2bd2a93d7f9dcfb6415baabc Mon Sep 17 00:00:00 2001 From: Kip Hart <41959581+kip-hart@users.noreply.github.com> Date: Tue, 2 Jan 2024 09:34:55 -0800 Subject: [PATCH 5/7] trimmed index --- docs/source/index.rst | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 1e55cb4..e27f55f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -2,7 +2,3 @@ .. include:: ../../README.rst :end-before: .. begin-introduction - - -.. include:: contents.rst - :start-after: .. Introduction From d7182be1c62183d9c81cb8d8309e433f996fed02 Mon Sep 17 00:00:00 2001 From: Kip Hart <41959581+kip-hart@users.noreply.github.com> Date: Tue, 2 Jan 2024 09:36:51 -0800 Subject: [PATCH 6/7] very simple index --- docs/source/index.rst | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index e27f55f..980a0d5 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,4 +1 @@ -.. AABBTree documentation master file. - -.. include:: ../../README.rst - :end-before: .. begin-introduction +Hello World! From c68cf900bb37c25df73feb7e52d0dd7865031b4c Mon Sep 17 00:00:00 2001 From: Kip Hart <41959581+kip-hart@users.noreply.github.com> Date: Tue, 2 Jan 2024 09:40:34 -0800 Subject: [PATCH 7/7] add title --- docs/source/index.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/source/index.rst b/docs/source/index.rst index 980a0d5..716c5bc 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1 +1,5 @@ +================= +Introduction +================= + Hello World!