[doc] Add API documentation

for reference:

sphinx-apidoc -o src/ ../ ../bumblebee-status ../bumblebee-ctl ../tests
This commit is contained in:
tobi-wan-kenobi 2020-05-04 20:27:11 +02:00
parent 7aa201dd30
commit 0b7f61b62e
6 changed files with 162 additions and 1 deletions

78
docs/src/core.rst Normal file
View file

@ -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:

8
docs/src/modules.rst Normal file
View file

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

70
docs/src/util.rst Normal file
View file

@ -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: