#57 add readthedocs yaml file and minor changes to dir structure

scribe-org · Feb 4, 2024 · b77d389 · b77d389
1 parent 0abe2fc
commit b77d389
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 2 deletions.
diff --git a/.readthedocs.yaml 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.9"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+ configuration: docs/source/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
diff --git a/...cs_internal/CONTRIBUTING_NO_BACK_LINKS.md → ...e/_internal/CONTRIBUTING_NO_BACK_LINKS.md b/...cs_internal/CONTRIBUTING_NO_BACK_LINKS.md → ...e/_internal/CONTRIBUTING_NO_BACK_LINKS.md
diff --git a/docs/source/_docs_internal/index.rst → docs/source/_internal/index.rst b/docs/source/_docs_internal/index.rst → docs/source/_internal/index.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -70,7 +70,7 @@ Installation
 .. toctree::
  :hidden:
 
- _docs_internal/index
+ _internal/index
 
 Project Indices
 ===============

diff --git a/docs/source/notes.rst b/docs/source/notes.rst
@@ -1,4 +1,4 @@
-.. mdinclude:: _docs_internal/CONTRIBUTING_NO_BACK_LINKS.md
+.. mdinclude:: _internal/CONTRIBUTING_NO_BACK_LINKS.md
 
 License
 =======