James Valleroy 2a8b9b94ba
app: Update diagnose() docstring
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
[sunil: Add reference documentation for the DiagnosticCheck and Result classes]
[sunil: Add link to DiagnosticCheck class from docstring]
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
2023-10-30 22:09:00 -07:00

45 lines
652 B
ReStructuredText

.. SPDX-License-Identifier: CC-BY-SA-4.0
Components
----------
.. toctree::
:caption: Available components:
info
enablestate
menu
packages
config
daemon
firewall
webserver
frontpage
domain
letsencrypt
users
staticfiles
backups
coturn
Base Classes
^^^^^^^^^^^^
.. autoclass:: plinth.app.Component
:members:
.. autoclass:: plinth.app.LeaderComponent
:members:
.. autoclass:: plinth.app.FollowerComponent
:members:
Other Classes
^^^^^^^^^^^^^
.. autoclass:: plinth.modules.diagnostics.check.DiagnosticCheck
:members:
.. autoclass:: plinth.modules.diagnostics.check.Result
:members: