Made project packable.

3 files changed, 75 insertions, 0 deletions

diff --git a/doc/.gitignore b/doc/.gitignore
new file mode 100644
index 0000000..af50aab
--- /dev/null
+++ b/doc/.gitignore
@@ -0,0 +1,2 @@
+rainbow_parenthesis*.rst
+modules.rst
diff --git a/doc/conf.py b/doc/conf.py
new file mode 100644
index 0000000..1a672b9
--- /dev/null
+++ b/doc/conf.py
@@ -0,0 +1,54 @@
+# 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
+# from __future__ import annotations
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('..'))
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'Rainbow Parenthesis'
+copyright = '2023, Hugo Hörnquist'
+author = 'Hugo Hörnquist'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+# Coverage not included, since flake8 already captures that
+
+extensions = [
+    'sphinx.ext.autodoc',   # Automatically extract source from pypthon files
+    'sphinx.ext.viewcode',  # Adds source viewer to output
+    'sphinx.ext.todo',      # Add todo-lists to output
+]
+
+# Actually enable the todo list
+todo_include_todos = True
+
+# Fancy type aliases.
+# For this to work, each module has to individually run
+#   from __future__ import annotations
+# Which will prevent type aliases from being eagerly evaluated.
+
+autodoc_type_aliases = {
+    'Markup': 'muppet.data.Markup',
+}
+
+# Add type signatures in parameter list of description, instead of in
+# signature. This reduces the clutter quite a bit.
+autodoc_typehints = 'description'
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'pyramid'
+html_static_path = ['_static']
diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644
index 0000000..300a8d4
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,19 @@
+Rainbow Parenthesis
+===================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents
+
+   modules
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+TODO
+====
+.. todolist::