arcanis/ahriman
1
0
Fork 0
mirror of https://github.com/arcan1s/ahriman.git synced 2025-07-22 18:29:56 +00:00
Code Issues Projects Releases Wiki Activity

Docstring update (#58)

Browse Source 
* 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:
Evgenii Alekseev
2022-04-17 20:25:28 +03:00
committed by GitHub
parent 06bd29b78d
commit 4daff81d5f
203 changed files with 5246 additions and 1636 deletions
Download Patch File Download Diff File Expand all files Collapse all files

95
docs/source/ahriman.core.formatters.rst Normal file
View File

@ -0,0 +1,95 @@
ahriman.core.formatters package
===============================
Submodules
----------
ahriman.core.formatters.aur\_printer module
-------------------------------------------
.. automodule:: ahriman.core.formatters.aur_printer
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.core.formatters.build\_printer module
---------------------------------------------
.. automodule:: ahriman.core.formatters.build_printer
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.core.formatters.configuration\_printer module
-----------------------------------------------------
.. automodule:: ahriman.core.formatters.configuration_printer
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.core.formatters.package\_printer module
-----------------------------------------------
.. automodule:: ahriman.core.formatters.package_printer
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.core.formatters.printer module
--------------------------------------
.. automodule:: ahriman.core.formatters.printer
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.core.formatters.status\_printer module
----------------------------------------------
.. automodule:: ahriman.core.formatters.status_printer
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.core.formatters.string\_printer module
----------------------------------------------
.. automodule:: ahriman.core.formatters.string_printer
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.core.formatters.update\_printer module
----------------------------------------------
.. automodule:: ahriman.core.formatters.update_printer
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.core.formatters.user\_printer module
--------------------------------------------
.. automodule:: ahriman.core.formatters.user_printer
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
Module contents
---------------
.. automodule:: ahriman.core.formatters
:members:
:no-undoc-members:
:show-inheritance:
:private-members: