From 0b7f61b62e236f4e5945279399f58941ffcdbf06 Mon Sep 17 00:00:00 2001
From: tobi-wan-kenobi <tobi-wan-kenobi@users.noreply.github.com>
Date: Mon, 4 May 2020 20:27:11 +0200
Subject: [PATCH] [doc] Add API documentation

for reference:

sphinx-apidoc -o src/ ../ ../bumblebee-status ../bumblebee-ctl ../tests
---
 __init__.py          |  0
 docs/conf.py         |  5 ++-
 docs/index.rst       |  2 ++
 docs/src/core.rst    | 78 ++++++++++++++++++++++++++++++++++++++++++++
 docs/src/modules.rst |  8 +++++
 docs/src/util.rst    | 70 +++++++++++++++++++++++++++++++++++++++
 6 files changed, 162 insertions(+), 1 deletion(-)
 delete mode 100644 __init__.py
 create mode 100644 docs/src/core.rst
 create mode 100644 docs/src/modules.rst
 create mode 100644 docs/src/util.rst

diff --git a/__init__.py b/__init__.py
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/conf.py b/docs/conf.py
index 0b98e57..505116a 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -21,13 +21,16 @@ project = "bumblebee-status"
 copyright = "2020, tobi-wan-kenobi"
 author = "tobi-wan-kenobi"
 
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
 
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions = ["sphinx.ext.autodoc"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
diff --git a/docs/index.rst b/docs/index.rst
index fa515d7..d430a75 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -17,6 +17,8 @@ Welcome to bumblebee-status's documentation!
    themes
    development/index
 
+   src/modules
+
 Indices and tables
 ==================
 
diff --git a/docs/src/core.rst b/docs/src/core.rst
new file mode 100644
index 0000000..e1b2eed
--- /dev/null
+++ b/docs/src/core.rst
@@ -0,0 +1,78 @@
+core package
+============
+
+Submodules
+----------
+
+core.config module
+------------------
+
+.. automodule:: core.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.decorators module
+----------------------
+
+.. automodule:: core.decorators
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.event module
+-----------------
+
+.. automodule:: core.event
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.input module
+-----------------
+
+.. automodule:: core.input
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.module module
+------------------
+
+.. automodule:: core.module
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.output module
+------------------
+
+.. automodule:: core.output
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.theme module
+-----------------
+
+.. automodule:: core.theme
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+core.widget module
+------------------
+
+.. automodule:: core.widget
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: core
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/src/modules.rst b/docs/src/modules.rst
new file mode 100644
index 0000000..bcb5083
--- /dev/null
+++ b/docs/src/modules.rst
@@ -0,0 +1,8 @@
+bumblebee-status
+================
+
+.. toctree::
+   :maxdepth: 4
+
+   core
+   util
diff --git a/docs/src/util.rst b/docs/src/util.rst
new file mode 100644
index 0000000..e127fca
--- /dev/null
+++ b/docs/src/util.rst
@@ -0,0 +1,70 @@
+util package
+============
+
+Submodules
+----------
+
+util.algorithm module
+---------------------
+
+.. automodule:: util.algorithm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+util.cli module
+---------------
+
+.. automodule:: util.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+util.format module
+------------------
+
+.. automodule:: util.format
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+util.graph module
+-----------------
+
+.. automodule:: util.graph
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+util.location module
+--------------------
+
+.. automodule:: util.location
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+util.popup module
+-----------------
+
+.. automodule:: util.popup
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+util.store module
+-----------------
+
+.. automodule:: util.store
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: util
+   :members:
+   :undoc-members:
+   :show-inheritance: