Done for today

HenryAsa · Sep 9, 2023 · 5d56054 · 5d56054
1 parent 9d1dbb9
commit 5d56054
Show file tree

Hide file tree

Showing 6 changed files with 110 additions and 15 deletions.
diff --git a/docs/source/_images/api.svg b/docs/source/_images/api.svg
diff --git a/docs/source/_images/getting_started.svg b/docs/source/_images/getting_started.svg
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -39,7 +39,7 @@
     'sphinx.ext.graphviz',
     'sphinx.ext.ifconfig',
     'numpydoc',
-    # 'sphinx_design'
+    'sphinx_design',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,16 +3,56 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Documentation for Email-Rules
-=============================
-
 .. toctree::
+   :maxdepth: 1
    :hidden:
 
    Home Page <self>
    API Reference <_autosummary/gmail_rules>
 
 
+Documentation for Email-Rules
+=============================
+Welcome to my email rules documentation site!
+
+
+.. grid:: 2
+
+   .. grid-item-card::
+      :img-top: ../source/_images/getting_started.svg
+
+      Getting Started
+      ^^^^^^^^^^^^^^^
+
+      Check out the Getting Started Guide.
+
+      +++
+
+      .. button-ref:: user_guide
+         :expand:
+         :color: secondary
+         :click-parent:
+
+         To the beginner's guide
+
+   .. grid-item-card::
+      :img-top: ../source/_images/api.svg
+
+      API Reference
+      ^^^^^^^^^^^^^
+
+      Link to the API Reference and associated documentation.
+
+      +++
+
+      .. button-ref:: _autosummary/gmail_rules
+         :expand:
+         :color: secondary
+         :click-parent:
+
+         To the API Reference
+
+
 Indices and Tables
 ==================
 

diff --git a/gmail_rules/actions/__init__.py b/gmail_rules/actions/__init__.py
@@ -1,11 +1,8 @@
 """
-Initialize actions module
+actions
+=======
 """
 
 from .rule_collection import Rule_Collection
 from .build_xmls import build_xml_text
 
-
-__all__ = [
-    "Rule_Collection",
-]
diff --git a/requirements.txt b/requirements.txt
@@ -1,19 +1,15 @@
 # Required packages
-
 setuptools
-cython>=0.29.30
 pkgconfig
 
 # For type annotations
-typing
-mypy>=0.981
 typing_extensions>=4.2.0
 
 # For testing
 pytest
 
 # For building docs
 sphinx>=4.5.0
-sphinx-design
-pydata-sphinx-theme
 numpydoc>=1.4
+pydata-sphinx-theme
+sphinx-design