ahriman/docs/source/ahriman.core.report.rst
Evgenii Alekseev 4daff81d5f Docstring update (#58)
* migrate docstrings from reST to google format

* add raises note

Also change behaviour of the `from_option` method to fallback to
disabled instead of raising exception on unknown option

* fix part of warnings for sphinx

* make identation a bit more readable

* review fixes

* add verbose description for properties to make them parsed by sphinx extenstion

* add demo sphinx generator
2022-04-17 20:25:28 +03:00

69 lines
1.4 KiB
ReStructuredText

ahriman.core.report package
===========================
Submodules
----------
ahriman.core.report.console module
----------------------------------
.. automodule:: ahriman.core.report.console
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.core.report.email module
--------------------------------
.. automodule:: ahriman.core.report.email
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.core.report.html module
-------------------------------
.. automodule:: ahriman.core.report.html
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.core.report.jinja\_template module
------------------------------------------
.. automodule:: ahriman.core.report.jinja_template
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.core.report.report module
---------------------------------
.. automodule:: ahriman.core.report.report
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.core.report.telegram module
-----------------------------------
.. automodule:: ahriman.core.report.telegram
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
Module contents
---------------
.. automodule:: ahriman.core.report
:members:
:no-undoc-members:
:show-inheritance:
:private-members: