From 6a91da98747cc5bee8a8c49ced9fce02afe8d3ab Mon Sep 17 00:00:00 2001
From: Drew DeHaas <drewdehaas@gmail.com>
Date: Fri, 28 Jun 2024 07:59:14 -0400
Subject: [PATCH] Prep for readthedocs integration

---
 .readthedocs.yaml           | 22 ++++++++++++++++++++++
 BUILDING.md => BuildDocs.md |  2 --
 Doxyfile.in                 |  2 +-
 doc/conf.py                 |  4 ++--
 4 files changed, 25 insertions(+), 5 deletions(-)
 create mode 100644 .readthedocs.yaml
 rename BUILDING.md => BuildDocs.md (69%)

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 0000000..4e1e86b
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,22 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+# Build documentation in the "doc/" directory with Sphinx
+sphinx:
+  configuration: doc/conf.py
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+    install:
+    - requirements: doc/requirements.txt
diff --git a/BUILDING.md b/BuildDocs.md
similarity index 69%
rename from BUILDING.md
rename to BuildDocs.md
index 555d83b..93e192d 100644
--- a/BUILDING.md
+++ b/BuildDocs.md
@@ -9,5 +9,3 @@ make -j
 doxygen ../Doxyfile.in
 DOC_BUILD_DIR=$PWD sphinx-build -c ../doc/ -b html -Dbreathe_projects.GRGL=$PWD/doc/xml ../doc/ $PWD/doc/sphinx/
 ```
-
-When publishing publically we'll need to download `pygrgl` from `pypi` to let this work without building the C++ code.
diff --git a/Doxyfile.in b/Doxyfile.in
index fb84403..0a45db9 100644
--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -32,7 +32,7 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = "GRGL"
+PROJECT_NAME           = "grgl"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version
diff --git a/doc/conf.py b/doc/conf.py
index 7f7f557..0fa486e 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -24,9 +24,9 @@
 
 # Breathe configuration
 breathe_projects = {
-    "GRGL": DOC_OUTPUT + "/xml/",
+    "grgl": DOC_OUTPUT + "/xml/",
 }
-breathe_default_project = "GRGL"
+breathe_default_project = "grgl"
 
 
 autosummary_generate = True  # Turn on sphinx.ext.autosummary