From d231fbfddd044cc4a19705feafc12b07b76a5503 Mon Sep 17 00:00:00 2001
From: Tomer Nosrati <d6.tomer@gmail.com>
Date: Thu, 19 Oct 2023 23:23:46 +0300
Subject: [PATCH] Attempt to get the read-the-docs to pass with empty docs

---
 .readthedocs.yaml     | 32 +++++++++++++++++++++++++++
 docs/conf.py          | 51 +++++++++++++++++++++++++++++++++++++++++++
 docs/index.rst        | 20 +++++++++++++++++
 docs/requirements.txt |  5 +++++
 4 files changed, 108 insertions(+)
 create mode 100644 .readthedocs.yaml
 create mode 100644 docs/conf.py
 create mode 100644 docs/index.rst
 create mode 100644 docs/requirements.txt

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 000000000..204bf655b
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,32 @@
+# 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
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# 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:
+    - method: pip
+      path: .
+    - requirements: docs/requirements.txt
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 000000000..ee301a85c
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,51 @@
+from sphinx_celery import conf
+
+globals().update(
+    conf.build_config(
+        "pytest-celery",
+        __file__,
+        project="pytest-celery",
+        version_dev="1.0.0a1",
+        version_stable="0.1.0",
+        canonical_url="https://docs.pytest-celery.dev",  # Update with your documentation URL
+        webdomain="pytest-celery.dev",  # Update with your domain
+        github_project="celery/pytest-celery",
+        author="Tomer Nosrati",
+        author_name="Tomer Nosrati",
+        copyright="2023",
+        publisher="Celery Project",
+        # html_logo='images/logo.png',
+        # html_favicon='images/favicon.ico',
+        html_prepend_sidebars=[],  # Update with your sidebar file if any, or remove this line if not needed
+        extra_extensions=[
+            "sphinx_click",
+            "sphinx.ext.napoleon",
+            # ... other extensions ...
+        ],
+        extra_intersphinx_mapping={
+            # ... other intersphinx mappings ...
+        },
+        apicheck_ignore_modules=[],
+        linkcheck_ignore=[r"^http://localhost"],
+        autodoc_mock_imports=[],  # Update with any modules that should be mocked, or remove this line if not needed
+    )
+)
+
+settings = {}
+ignored_settings = {
+    # Update with any deprecated settings or remove this block if not needed
+}
+
+
+def configcheck_project_settings():
+    # Update with your project settings or remove this function if not needed
+    pass
+
+
+def is_deprecated_setting(setting):
+    # Update with your project settings or remove this function if not needed
+    pass
+
+
+def configcheck_should_ignore(setting):
+    return setting in ignored_settings or is_deprecated_setting(setting)
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 000000000..3be30fd82
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,20 @@
+.. pytest-celery documentation master file, created by
+   sphinx-quickstart on Tue Oct 19 13:33:33 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to pytest-celery's documentation!
+==========================================
+
+Contents:
+---------
+
+.. toctree::
+   :maxdepth: 2
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 000000000..8dcba2c94
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,5 @@
+sphinx_celery>=2.0.0
+Sphinx==5.3.0
+sphinx-testing~=1.0.1
+sphinx-click==4.4.0
+libmemcached-dev