[docs] Update API doc to new package structure
This commit is contained in:
parent
f78981b226
commit
560083ce0c
6 changed files with 180 additions and 150 deletions
|
@ -4,5 +4,4 @@ API Reference
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 4
|
:maxdepth: 4
|
||||||
|
|
||||||
src/core
|
src/bumblebee_status
|
||||||
src/util
|
|
||||||
|
|
78
docs/src/bumblebee_status.core.rst
Normal file
78
docs/src/bumblebee_status.core.rst
Normal file
|
@ -0,0 +1,78 @@
|
||||||
|
bumblebee\_status.core package
|
||||||
|
==============================
|
||||||
|
|
||||||
|
Submodules
|
||||||
|
----------
|
||||||
|
|
||||||
|
bumblebee\_status.core.config module
|
||||||
|
------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: bumblebee_status.core.config
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
bumblebee\_status.core.decorators module
|
||||||
|
----------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: bumblebee_status.core.decorators
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
bumblebee\_status.core.event module
|
||||||
|
-----------------------------------
|
||||||
|
|
||||||
|
.. automodule:: bumblebee_status.core.event
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
bumblebee\_status.core.input module
|
||||||
|
-----------------------------------
|
||||||
|
|
||||||
|
.. automodule:: bumblebee_status.core.input
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
bumblebee\_status.core.module module
|
||||||
|
------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: bumblebee_status.core.module
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
bumblebee\_status.core.output module
|
||||||
|
------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: bumblebee_status.core.output
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
bumblebee\_status.core.theme module
|
||||||
|
-----------------------------------
|
||||||
|
|
||||||
|
.. automodule:: bumblebee_status.core.theme
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
bumblebee\_status.core.widget module
|
||||||
|
------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: bumblebee_status.core.widget
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
|
||||||
|
Module contents
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. automodule:: bumblebee_status.core
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
31
docs/src/bumblebee_status.rst
Normal file
31
docs/src/bumblebee_status.rst
Normal file
|
@ -0,0 +1,31 @@
|
||||||
|
bumblebee\_status package
|
||||||
|
=========================
|
||||||
|
|
||||||
|
Subpackages
|
||||||
|
-----------
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 4
|
||||||
|
|
||||||
|
bumblebee_status.core
|
||||||
|
bumblebee_status.util
|
||||||
|
|
||||||
|
Submodules
|
||||||
|
----------
|
||||||
|
|
||||||
|
bumblebee\_status.discover module
|
||||||
|
---------------------------------
|
||||||
|
|
||||||
|
.. automodule:: bumblebee_status.discover
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
|
||||||
|
Module contents
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. automodule:: bumblebee_status
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
70
docs/src/bumblebee_status.util.rst
Normal file
70
docs/src/bumblebee_status.util.rst
Normal file
|
@ -0,0 +1,70 @@
|
||||||
|
bumblebee\_status.util package
|
||||||
|
==============================
|
||||||
|
|
||||||
|
Submodules
|
||||||
|
----------
|
||||||
|
|
||||||
|
bumblebee\_status.util.algorithm module
|
||||||
|
---------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: bumblebee_status.util.algorithm
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
bumblebee\_status.util.cli module
|
||||||
|
---------------------------------
|
||||||
|
|
||||||
|
.. automodule:: bumblebee_status.util.cli
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
bumblebee\_status.util.format module
|
||||||
|
------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: bumblebee_status.util.format
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
bumblebee\_status.util.graph module
|
||||||
|
-----------------------------------
|
||||||
|
|
||||||
|
.. automodule:: bumblebee_status.util.graph
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
bumblebee\_status.util.location module
|
||||||
|
--------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: bumblebee_status.util.location
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
bumblebee\_status.util.popup module
|
||||||
|
-----------------------------------
|
||||||
|
|
||||||
|
.. automodule:: bumblebee_status.util.popup
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
bumblebee\_status.util.store module
|
||||||
|
-----------------------------------
|
||||||
|
|
||||||
|
.. automodule:: bumblebee_status.util.store
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
|
||||||
|
Module contents
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. automodule:: bumblebee_status.util
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
|
@ -1,78 +0,0 @@
|
||||||
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:
|
|
|
@ -1,70 +0,0 @@
|
||||||
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:
|
|
Loading…
Reference in a new issue