From 0c1d7e50d8446f5f681848b7e9d59b8968ad9f1e Mon Sep 17 00:00:00 2001 From: Richard Bowman Date: Thu, 6 Aug 2026 13:19:50 +0100 Subject: [PATCH 1/2] Fix a syntax error in the public API docs. --- docs/source/public_api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/public_api.rst b/docs/source/public_api.rst index 38426a6f..9f276fe0 100644 --- a/docs/source/public_api.rst +++ b/docs/source/public_api.rst @@ -333,7 +333,7 @@ This page summarises the parts of the LabThings API that should be most frequent :no-index: .. py:property:: global_lock - :type GlobalLock | None: + :type: GlobalLock | None A global lock object that is used to restrict concurrent execution of actions and setting of properties. From ae173ebeb0231aa33165f256693e095151fa94ad Mon Sep 17 00:00:00 2001 From: Richard Bowman Date: Thu, 6 Aug 2026 15:32:25 +0100 Subject: [PATCH 2/2] Fix links in contributing document I've converted relative to absolute links (to the github web interface) so that they are clickable. This isn't wonderfully elegant, but it works. --- docs/source/contributing.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/source/contributing.md b/docs/source/contributing.md index 468de7c7..a97e7bef 100644 --- a/docs/source/contributing.md +++ b/docs/source/contributing.md @@ -30,7 +30,9 @@ We welcome pull requests for bug fixes, new features, and documentation improvem ### 1. Local Development Setup To work on the code, you will need to clone the repository and install the development dependencies. -Please see the [installation notes](./README.md#installation-notes) for more detail about compatible Python versions and Windows installation. +Please see the [installation notes] for more detail about compatible Python versions and Windows installation. + +[installation notes]: https://github.com/labthings/labthings-fastapi/blob/main/README.md#installation-notes ```bash # Clone the repository @@ -117,7 +119,7 @@ All changes to the codebase must go via pull requests. Unless you are a core mai [OpenFlexure Microscope software]: https://gitlab.com/openflexure/openflexure-microscope-server/ [GitHub Actions]: https://github.com/labthings/labthings-fastapi/actions [`ruff`]: https://docs.astral.sh/ruff/ -[`pyproject.toml`]: ./pyproject.toml +[`pyproject.toml`]: https://github.com/labthings/labthings-fastapi/blob/main/pyproject.toml [`flake8`]: https://flake8.pycqa.org/en/latest/ [`mypy`]: https://mypy-lang.org/ [`pytest`]: https://docs.pytest.org/en/stable/