mirror of
https://github.com/arcan1s/ahriman.git
synced 2025-07-23 10:49:55 +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:
32
docs/source/ahriman.web.middlewares.rst
Normal file
32
docs/source/ahriman.web.middlewares.rst
Normal file
@ -0,0 +1,32 @@
|
||||
ahriman.web.middlewares package
|
||||
===============================
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
ahriman.web.middlewares.auth\_handler module
|
||||
--------------------------------------------
|
||||
|
||||
.. automodule:: ahriman.web.middlewares.auth_handler
|
||||
:members:
|
||||
:no-undoc-members:
|
||||
:show-inheritance:
|
||||
:private-members:
|
||||
|
||||
ahriman.web.middlewares.exception\_handler module
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: ahriman.web.middlewares.exception_handler
|
||||
:members:
|
||||
:no-undoc-members:
|
||||
:show-inheritance:
|
||||
:private-members:
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: ahriman.web.middlewares
|
||||
:members:
|
||||
:no-undoc-members:
|
||||
:show-inheritance:
|
||||
:private-members:
|
Reference in New Issue
Block a user