[doc] Add API documentation

for reference:

sphinx-apidoc -o src/ ../ ../bumblebee-status ../bumblebee-ctl ../tests

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"]

docs/index.rst

@@ -17,6 +17,8 @@ Welcome to bumblebee-status's documentation!
    themes
    development/index
 
+   src/modules
+
 Indices and tables
 ==================
 

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:

docs/src/modules.rst

@@ -0,0 +1,8 @@
+bumblebee-status
+================
+
+.. toctree::
+   :maxdepth: 4
+
+   core
+   util

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: