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:
2022-04-17 20:25:28 +03:00
committed by GitHub
parent 0db619136d
commit d90f417cae
203 changed files with 5246 additions and 1636 deletions

View File

@ -0,0 +1,59 @@
ahriman.core.upload package
===========================
Submodules
----------
ahriman.core.upload.github module
---------------------------------
.. automodule:: ahriman.core.upload.github
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.core.upload.http\_upload module
---------------------------------------
.. automodule:: ahriman.core.upload.http_upload
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.core.upload.rsync module
--------------------------------
.. automodule:: ahriman.core.upload.rsync
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.core.upload.s3 module
-----------------------------
.. automodule:: ahriman.core.upload.s3
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.core.upload.upload module
---------------------------------
.. automodule:: ahriman.core.upload.upload
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
Module contents
---------------
.. automodule:: ahriman.core.upload
:members:
:no-undoc-members:
:show-inheritance:
:private-members: