update docs

docs/_static/css/style.css

@@ -0,0 +1,3 @@
+div.related {
+    background-color: darkslategray;
+}

docs/clubs.poker.rst

@@ -1,19 +1,21 @@
-clubs.poker package
-===================
+clubs.poker
+============
 
-Submodules
-----------
+.. .. toctree::
+..    :maxdepth: 4
 
-clubs.poker.card module
------------------------
+..    clubs.poker
+
+Card
+----
 
 .. automodule:: clubs.poker.card
    :members:
    :undoc-members:
    :show-inheritance:
 
-clubs.poker.engine module
--------------------------
+Engine
+------
 
 .. automodule:: clubs.poker.engine
    :members:

docs/conf.py

@@ -15,12 +15,14 @@
 
 sys.path.insert(0, os.path.abspath(".."))
 
+import clubs  # noqa: E402
 
 # -- Project information -----------------------------------------------------
 
-project = "clubs"
-copyright = "2021, Ferdinand Schlatt"
-author = "Ferdinand Schlatt"
+project = clubs.__name__
+copyright = clubs.__copyright__
+author = clubs.__author__
+version = clubs.__version__
 
 
 # -- General configuration ---------------------------------------------------
@@ -56,7 +58,10 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "alabaster"
+html_theme = "nature"
+
+html_logo = "../clubs/render/resources/static/images/black_red_logo.svg"
+html_favicon = "../clubs/render/resources/static/images/black_red_logo.svg"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -70,3 +75,16 @@
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
+
+
+autodoc_default_options = {
+    "members": True,
+    "methods": True,
+    "special-members": "__call__",
+    "exclude-members": "_abc_impl",
+    "show-inheritance": True,
+}
+
+
+def setup(app):
+    app.add_css_file("css/style.css")

docs/index.rst

@@ -3,14 +3,25 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to clubs's documentation!
-=================================
+.. poker: card, deck
+.. dealer
+.. lookup table, evaluator
+.. render
+
+Clubs documentation!
+====================
+
+
+Engine
+------
 
 .. toctree::
-   :maxdepth: 4
+   :maxdepth: 1
+   :name: start
    :caption: Contents:
 
-   clubs
+   clubs/poker/card
+   clubs.poker
 
 
 Indices and tables