mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-28 08:03:36 +00:00
doc: dev: Document previously undocumented components
Tests: - Build HTML and ensure build succeeds that the changes are reflected. Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org> Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
This commit is contained in:
parent
bd90e59fa3
commit
ce709ca8ce
@ -5,3 +5,6 @@ Daemon
|
||||
|
||||
.. autoclass:: plinth.daemon.Daemon
|
||||
:members:
|
||||
|
||||
.. autoclass:: plinth.daemon.RelatedDaemon
|
||||
:members:
|
||||
|
||||
7
doc/dev/reference/components/enablestate.rst
Normal file
7
doc/dev/reference/components/enablestate.rst
Normal file
@ -0,0 +1,7 @@
|
||||
.. SPDX-License-Identifier: CC-BY-SA-4.0
|
||||
|
||||
EnableState
|
||||
^^^^^^^^^^^
|
||||
|
||||
.. autoclass:: plinth.app.EnableState
|
||||
:members:
|
||||
@ -7,6 +7,7 @@ Components
|
||||
:caption: Available components:
|
||||
|
||||
info
|
||||
enablestate
|
||||
menu
|
||||
packages
|
||||
daemon
|
||||
@ -15,6 +16,7 @@ Components
|
||||
frontpage
|
||||
domain
|
||||
letsencrypt
|
||||
users
|
||||
staticfiles
|
||||
backups
|
||||
coturn
|
||||
|
||||
7
doc/dev/reference/components/users.rst
Normal file
7
doc/dev/reference/components/users.rst
Normal file
@ -0,0 +1,7 @@
|
||||
.. SPDX-License-Identifier: CC-BY-SA-4.0
|
||||
|
||||
Users
|
||||
^^^^^
|
||||
|
||||
.. autoclass:: plinth.modules.users.components.UsersAndGroups
|
||||
:members:
|
||||
@ -455,7 +455,16 @@ class Info(FollowerComponent):
|
||||
|
||||
|
||||
class EnableState(LeaderComponent):
|
||||
"""A component to hold the enable state of an app using a simple flag."""
|
||||
"""A component to hold the enable state of an app using a simple flag.
|
||||
|
||||
The flag is stored in the FreedomBox service database. This component
|
||||
should only be used if an app does not have any other way to determine if
|
||||
it is enabled or disabled by examining the state of the system. Typical
|
||||
apps have daemons, web server configuration, etc. and the enabled/disabled
|
||||
state of those determine the enabled/disabled state of the entire app. If
|
||||
an does not have any such system state, then this component may be used to
|
||||
provide enable/disable functionality for the app.
|
||||
"""
|
||||
|
||||
@property
|
||||
def key(self):
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user