mirror of
https://github.com/arcan1s/ahriman.git
synced 2025-07-23 02:39:57 +00:00
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
This commit is contained in:
41
docs/source/ahriman.application.rst
Normal file
41
docs/source/ahriman.application.rst
Normal file
@ -0,0 +1,41 @@
|
||||
ahriman.application package
|
||||
===========================
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
ahriman.application.application
|
||||
ahriman.application.handlers
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
ahriman.application.ahriman module
|
||||
----------------------------------
|
||||
|
||||
.. automodule:: ahriman.application.ahriman
|
||||
:members:
|
||||
:no-undoc-members:
|
||||
:show-inheritance:
|
||||
:private-members:
|
||||
|
||||
ahriman.application.lock module
|
||||
-------------------------------
|
||||
|
||||
.. automodule:: ahriman.application.lock
|
||||
:members:
|
||||
:no-undoc-members:
|
||||
:show-inheritance:
|
||||
:private-members:
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: ahriman.application
|
||||
:members:
|
||||
:no-undoc-members:
|
||||
:show-inheritance:
|
||||
:private-members:
|
Reference in New Issue
Block a user