Initial documentation structure (#158)

Author: Nusnus

Changelog.rst

@@ -0,0 +1,7 @@
+.. _changelog:
+
+================
+ Change history
+================
+
+TBD

docs/changelog.rst

@@ -0,0 +1 @@
+.. include:: ../Changelog.rst

docs/contributing.rst

@@ -0,0 +1 @@
+.. include:: ../CONTRIBUTING.rst

docs/faq.rst

@@ -0,0 +1,27 @@
+.. _faq:
+
+============================
+ Frequently Asked Questions
+============================
+
+.. contents::
+    :local:
+
+.. _faq-general:
+
+General
+=======
+
+.. _faq-tbd-1:
+
+TBD 1?
+------
+
+**Answer:** Yes/No.
+
+.. _faq-tbd-2:
+
+TBD 2?
+------
+
+**Answer:** Yes/No.

docs/getting-started/index.rst

@@ -0,0 +1,15 @@
+=================
+ Getting Started
+=================
+
+:Release: |version|
+:Date: |today|
+
+.. toctree::
+    :maxdepth: 2
+
+    introduction
+    backends-and-brokers/index
+    first-steps-with-celery
+    next-steps
+    resources

docs/getting-started/introduction.rst

@@ -0,0 +1,14 @@
+.. _intro:
+
+===============================
+ Introduction to Pytest Celery
+===============================
+
+.. contents::
+    :local:
+    :depth: 1
+
+TBD?
+====
+
+TBD.

docs/index.rst

@@ -1,20 +1,45 @@
-.. 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.
+===================================================
+ pytest-celery - Testing Infrastructure for Celery
+===================================================
 
-Welcome to pytest-celery's documentation!
-==========================================
+TBD
 
-Contents:
----------
+pytest-celery has a growing community of users and contributors. Join us
+in making pytest-celery even better!
+
+pytest-celery is Open Source and licensed under the BSD License.
+
+Supporting pytest-celery
+========================
+
+Your contributions support the continued development of pytest-celery.
+
+If you find pytest-celery valuable, please consider supporting us to ensure its
+future growth and maintenance.
+
+Getting Started
+===============
+
+- Begin your journey with pytest-celery by following the :ref:`getting-started`.
+- For common questions, you might want to check out the :ref:`faq`.
+
+Contents
+========
+
+.. toctree::
+    :maxdepth: 1
+
+    introduction
+    getting-started/index
 
 .. toctree::
-   :maxdepth: 2
+    :maxdepth: 2
+
+    userguide/index
 
-Indices and tables
-==================
+.. toctree::
+    :maxdepth: 1
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+    faq
+    changelog
+    contributing

docs/userguide/index.rst

@@ -0,0 +1,13 @@
+.. _guide:
+
+============
+ User Guide
+============
+
+:Release: |version|
+:Date: |today|
+
+.. toctree::
+    :maxdepth: 1
+
+    tbd

docs/userguide/tbd.rst

@@ -0,0 +1,21 @@
+.. _guide-tbd:
+
+====
+ TBD
+====
+
+.. contents::
+    :local:
+    :depth: 1
+
+TBD
+
+Title Placeholder 1
+===================
+
+TBD
+
+Title Placeholder 2
+===================
+
+TBD