Add Sphinx documentation code

Electronic-Mango · Electronic-Mango · commit 3c96dda59615 · 2023-11-25T21:37:21.000+01:00
diff --git a/docs/conf.py b/docs/conf.py
@@ -0,0 +1,31 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "Reddit Python API"
+copyright = "2023, Electronic-Mango"
+author = "Electronic-Mango"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,22 @@
+.. Reddit Python API documentation master file, created by
+   sphinx-quickstart on Sat Nov 25 21:28:54 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Reddit Python API's documentation!
+=============================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/modules.rst b/docs/modules.rst
@@ -0,0 +1,7 @@
+redditpythonapi
+===============
+
+.. toctree::
+   :maxdepth: 4
+
+   redditpythonapi
diff --git a/docs/redditpythonapi.rst b/docs/redditpythonapi.rst
@@ -0,0 +1,21 @@
+redditpythonapi package
+=======================
+
+Submodules
+----------
+
+redditpythonapi.reddit module
+-----------------------------
+
+.. automodule:: redditpythonapi.reddit
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: redditpythonapi
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/requirements.txt b/requirements.txt
