From a2d2be9b436832e70cd1dc36cccbd06fb2741240 Mon Sep 17 00:00:00 2001 From: Keith Bourgoin Date: Mon, 5 Aug 2024 13:28:03 -0400 Subject: [PATCH] Add readthedocs.ini and remove an unnecessary folder level. --- .readthedocs.yaml | 22 +++++++++++++++++++ doc/{source => }/api.rst | 0 doc/{source => }/conf.py | 0 doc/{source => }/develop.rst | 0 doc/{source => }/faq.rst | 0 doc/{source => }/images/quickstart.gif | Bin doc/{source => }/images/redis.gif | Bin doc/{source => }/images/streamparse-logo.png | Bin doc/{source => }/images/streamparse_arch.png | Bin doc/{source => }/index.rst | 0 doc/{source => }/quickstart.rst | 0 doc/{source => }/releases.rst | 0 doc/{source => }/topologies.rst | 0 13 files changed, 22 insertions(+) create mode 100644 .readthedocs.yaml rename doc/{source => }/api.rst (100%) rename doc/{source => }/conf.py (100%) rename doc/{source => }/develop.rst (100%) rename doc/{source => }/faq.rst (100%) rename doc/{source => }/images/quickstart.gif (100%) rename doc/{source => }/images/redis.gif (100%) rename doc/{source => }/images/streamparse-logo.png (100%) rename doc/{source => }/images/streamparse_arch.png (100%) rename doc/{source => }/index.rst (100%) rename doc/{source => }/quickstart.rst (100%) rename doc/{source => }/releases.rst (100%) rename doc/{source => }/topologies.rst (100%) diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..e90b43a1 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,22 @@ +# Read the Docs configuration file for Sphinx projects +# 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 "docs/" directory with Sphinx +sphinx: + configuration: docs/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: docs/requirements.txt diff --git a/doc/source/api.rst b/doc/api.rst similarity index 100% rename from doc/source/api.rst rename to doc/api.rst diff --git a/doc/source/conf.py b/doc/conf.py similarity index 100% rename from doc/source/conf.py rename to doc/conf.py diff --git a/doc/source/develop.rst b/doc/develop.rst similarity index 100% rename from doc/source/develop.rst rename to doc/develop.rst diff --git a/doc/source/faq.rst b/doc/faq.rst similarity index 100% rename from doc/source/faq.rst rename to doc/faq.rst diff --git a/doc/source/images/quickstart.gif b/doc/images/quickstart.gif similarity index 100% rename from doc/source/images/quickstart.gif rename to doc/images/quickstart.gif diff --git a/doc/source/images/redis.gif b/doc/images/redis.gif similarity index 100% rename from doc/source/images/redis.gif rename to doc/images/redis.gif diff --git a/doc/source/images/streamparse-logo.png b/doc/images/streamparse-logo.png similarity index 100% rename from doc/source/images/streamparse-logo.png rename to doc/images/streamparse-logo.png diff --git a/doc/source/images/streamparse_arch.png b/doc/images/streamparse_arch.png similarity index 100% rename from doc/source/images/streamparse_arch.png rename to doc/images/streamparse_arch.png diff --git a/doc/source/index.rst b/doc/index.rst similarity index 100% rename from doc/source/index.rst rename to doc/index.rst diff --git a/doc/source/quickstart.rst b/doc/quickstart.rst similarity index 100% rename from doc/source/quickstart.rst rename to doc/quickstart.rst diff --git a/doc/source/releases.rst b/doc/releases.rst similarity index 100% rename from doc/source/releases.rst rename to doc/releases.rst diff --git a/doc/source/topologies.rst b/doc/topologies.rst similarity index 100% rename from doc/source/topologies.rst rename to doc/topologies.rst