add more API to doc

This commit is contained in:
boyska 2025-03-01 13:25:16 +01:00
parent 53f8108715
commit 07ad4a2a7a
3 changed files with 314 additions and 1 deletions

1
.gitignore vendored
View file

@ -10,6 +10,5 @@ larigira.db_*
*.json
.coverage
*.db
doc/source/api/larigira.rst
.eggs/
.cache/

View file

@ -0,0 +1,21 @@
larigira.dbadmin package
========================
Submodules
----------
larigira.dbadmin.suggestions module
-----------------------------------
.. automodule:: larigira.dbadmin.suggestions
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: larigira.dbadmin
:members:
:undoc-members:
:show-inheritance:

293
doc/source/api/larigira.rst Normal file
View file

@ -0,0 +1,293 @@
larigira package
================
Subpackages
-----------
.. toctree::
:maxdepth: 4
larigira.filters
Submodules
----------
larigira.audioform\_base module
-------------------------------
.. automodule:: larigira.audioform_base
:members:
:undoc-members:
:show-inheritance:
larigira.audioform\_http module
-------------------------------
.. automodule:: larigira.audioform_http
:members:
:undoc-members:
:show-inheritance:
larigira.audioform\_mostrecent module
-------------------------------------
.. automodule:: larigira.audioform_mostrecent
:members:
:undoc-members:
:show-inheritance:
larigira.audioform\_podcast module
----------------------------------
.. automodule:: larigira.audioform_podcast
:members:
:undoc-members:
:show-inheritance:
larigira.audioform\_randomdir module
------------------------------------
.. automodule:: larigira.audioform_randomdir
:members:
:undoc-members:
:show-inheritance:
larigira.audioform\_script module
---------------------------------
.. automodule:: larigira.audioform_script
:members:
:undoc-members:
:show-inheritance:
larigira.audioform\_static module
---------------------------------
.. automodule:: larigira.audioform_static
:members:
:undoc-members:
:show-inheritance:
larigira.audiogen module
------------------------
.. automodule:: larigira.audiogen
:members:
:undoc-members:
:show-inheritance:
larigira.audiogen\_http module
------------------------------
.. automodule:: larigira.audiogen_http
:members:
:undoc-members:
:show-inheritance:
larigira.audiogen\_mostrecent module
------------------------------------
.. automodule:: larigira.audiogen_mostrecent
:members:
:undoc-members:
:show-inheritance:
larigira.audiogen\_mpdrandom module
-----------------------------------
.. automodule:: larigira.audiogen_mpdrandom
:members:
:undoc-members:
:show-inheritance:
larigira.audiogen\_podcast module
---------------------------------
.. automodule:: larigira.audiogen_podcast
:members:
:undoc-members:
:show-inheritance:
larigira.audiogen\_randomdir module
-----------------------------------
.. automodule:: larigira.audiogen_randomdir
:members:
:undoc-members:
:show-inheritance:
larigira.audiogen\_script module
--------------------------------
.. automodule:: larigira.audiogen_script
:members:
:undoc-members:
:show-inheritance:
larigira.audiogen\_static module
--------------------------------
.. automodule:: larigira.audiogen_static
:members:
:undoc-members:
:show-inheritance:
larigira.config module
----------------------
.. automodule:: larigira.config
:members:
:undoc-members:
:show-inheritance:
larigira.db module
------------------
.. automodule:: larigira.db
:members:
:undoc-members:
:show-inheritance:
larigira.entrypoints\_utils module
----------------------------------
.. automodule:: larigira.entrypoints_utils
:members:
:undoc-members:
:show-inheritance:
larigira.event module
---------------------
.. automodule:: larigira.event
:members:
:undoc-members:
:show-inheritance:
larigira.event\_manage module
-----------------------------
.. automodule:: larigira.event_manage
:members:
:undoc-members:
:show-inheritance:
larigira.eventutils module
--------------------------
.. automodule:: larigira.eventutils
:members:
:undoc-members:
:show-inheritance:
larigira.forms module
---------------------
.. automodule:: larigira.forms
:members:
:undoc-members:
:show-inheritance:
larigira.formutils module
-------------------------
.. automodule:: larigira.formutils
:members:
:undoc-members:
:show-inheritance:
larigira.fsutils module
-----------------------
.. automodule:: larigira.fsutils
:members:
:undoc-members:
:show-inheritance:
larigira.main module
--------------------
.. automodule:: larigira.main
:members:
:undoc-members:
:show-inheritance:
larigira.mpc module
-------------------
.. automodule:: larigira.mpc
:members:
:undoc-members:
:show-inheritance:
larigira.test\_unused module
----------------------------
.. automodule:: larigira.test_unused
:members:
:undoc-members:
:show-inheritance:
larigira.timeform\_base module
------------------------------
.. automodule:: larigira.timeform_base
:members:
:undoc-members:
:show-inheritance:
larigira.timeform\_cron module
------------------------------
.. automodule:: larigira.timeform_cron
:members:
:undoc-members:
:show-inheritance:
larigira.timegen module
-----------------------
.. automodule:: larigira.timegen
:members:
:undoc-members:
:show-inheritance:
larigira.timegen\_cron module
-----------------------------
.. automodule:: larigira.timegen_cron
:members:
:undoc-members:
:show-inheritance:
larigira.timegen\_every module
------------------------------
.. automodule:: larigira.timegen_every
:members:
:undoc-members:
:show-inheritance:
larigira.timegen\_exclusions module
-----------------------------------
.. automodule:: larigira.timegen_exclusions
:members:
:undoc-members:
:show-inheritance:
larigira.unused module
----------------------
.. automodule:: larigira.unused
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: larigira
:members:
:undoc-members:
:show-inheritance: