diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..7374d55b --- /dev/null +++ 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/docs/source/_docs_internal/CONTRIBUTING_NO_BACK_LINKS.md b/docs/source/_internal/CONTRIBUTING_NO_BACK_LINKS.md similarity index 100% rename from docs/source/_docs_internal/CONTRIBUTING_NO_BACK_LINKS.md rename to docs/source/_internal/CONTRIBUTING_NO_BACK_LINKS.md diff --git a/docs/source/_docs_internal/index.rst b/docs/source/_internal/index.rst similarity index 100% rename from docs/source/_docs_internal/index.rst rename to docs/source/_internal/index.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index 262f9d2e..8c81f6a5 100644 --- 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 index 18cfa461..0ab6daaf 100644 --- 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 =======