ahriman/docs/source/ahriman.models.rst
Evgenii Alekseev d90f417cae
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

204 lines
4.2 KiB
ReStructuredText

ahriman.models package
======================
Submodules
----------
ahriman.models.action module
----------------------------
.. automodule:: ahriman.models.action
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.models.aur\_package module
----------------------------------
.. automodule:: ahriman.models.aur_package
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.models.auth\_settings module
------------------------------------
.. automodule:: ahriman.models.auth_settings
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.models.build\_status module
-----------------------------------
.. automodule:: ahriman.models.build_status
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.models.counters module
------------------------------
.. automodule:: ahriman.models.counters
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.models.internal\_status module
--------------------------------------
.. automodule:: ahriman.models.internal_status
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.models.migration module
-------------------------------
.. automodule:: ahriman.models.migration
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.models.migration\_result module
---------------------------------------
.. automodule:: ahriman.models.migration_result
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.models.package module
-----------------------------
.. automodule:: ahriman.models.package
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.models.package\_description module
------------------------------------------
.. automodule:: ahriman.models.package_description
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.models.package\_source module
-------------------------------------
.. automodule:: ahriman.models.package_source
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.models.property module
------------------------------
.. automodule:: ahriman.models.property
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.models.report\_settings module
--------------------------------------
.. automodule:: ahriman.models.report_settings
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.models.repository\_paths module
---------------------------------------
.. automodule:: ahriman.models.repository_paths
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.models.result module
----------------------------
.. automodule:: ahriman.models.result
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.models.sign\_settings module
------------------------------------
.. automodule:: ahriman.models.sign_settings
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.models.smtp\_ssl\_settings module
-----------------------------------------
.. automodule:: ahriman.models.smtp_ssl_settings
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.models.upload\_settings module
--------------------------------------
.. automodule:: ahriman.models.upload_settings
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.models.user module
--------------------------
.. automodule:: ahriman.models.user
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.models.user\_access module
----------------------------------
.. automodule:: ahriman.models.user_access
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
ahriman.models.user\_identity module
------------------------------------
.. automodule:: ahriman.models.user_identity
:members:
:no-undoc-members:
:show-inheritance:
:private-members:
Module contents
---------------
.. automodule:: ahriman.models
:members:
:no-undoc-members:
:show-inheritance:
:private-members: