Skip to content

Docs fixes #336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rwb27 merged 2 commits into from
May 7, 2026
+4 −5
Merged

Docs fixes #336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a8522a
Add API prefix to public API docs
rwb27 May 7, 2026
8d8b858
Remove feature flags from documentation
rwb27 May 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/properties.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ Note that the constraints for functional properties are set by assigning a dicti
.. note::

Currently, property values are not validated when they are set directly in Python, only via HTTP.
Setting ``lt.FEATURE_FLAGS.validate_properties_on_set = True`` enables validation when they are set in Python. This may become default behaviour in the future.
Setting ``validate_properties_on_set = True`` in `~lt.Thing._class_settings` enables validation when they are set in Python. This may become default behaviour in the future.

Property metadata
-----------------
Expand Down
7 changes: 3 additions & 4 deletions docs/source/public_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,6 +365,9 @@ This page summarises the parts of the LabThings API that should be most frequent
.. autoattribute:: labthings_fastapi.server.config_model.ThingServerConfig.settings_folder
:no-index:

.. autoattribute:: labthings_fastapi.server.config_model.ThingServerConfig.api_prefix
:no-index:

.. autoattribute:: labthings_fastapi.server.config_model.ThingServerConfig.enable_global_lock
:no-index:

Expand Down Expand Up @@ -516,10 +519,6 @@ This page summarises the parts of the LabThings API that should be most frequent

This is an alias of `labthings_fastapi.properties.DataSetting` but is not usually used: consider using `property` instead.

.. py:attribute:: FEATURE_FLAGS

Feature flags are used to control optional features of LabThings. Setting the attributes of `FEATURE_FLAGS` enables or disables a feature. It is an instance of the dataclass `labthings_fastapi.feature_flags.LabThingsFeatureFlags` and the various available options are described there.

.. py:attribute:: outputs

This is an alias for `labthings_fastapi.outputs` and contains, for example `MJPEGStream`\ .
Expand Down
Loading