Merge branch 'ReadTheDoc' into merge-yt (yt-project/libyt main branch)

yt-project · Feb 16, 2024 · 28dd1a6 · 28dd1a6
2 parents 2af747b + f7f451a
commit 28dd1a6
Show file tree

Hide file tree

Showing 76 changed files with 1,342 additions and 1,865 deletions.
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,27 @@
+# .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 OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+# Build documentation in the "doc/" directory with Sphinx
+sphinx:
+  configuration: doc/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats:
+  - htmlzip
+
+# 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/doc/DebugAndTimeProfiling/TimeProfiling.md b/doc/DebugAndTimeProfiling/TimeProfiling.md
diff --git a/doc/DebugAndTimeProfiling/index.md b/doc/DebugAndTimeProfiling/index.md
diff --git a/doc/FAQs.md b/doc/FAQs.md
diff --git a/doc/Gemfile b/doc/Gemfile
diff --git a/doc/Gemfile.lock b/doc/Gemfile.lock