Skip to content

Minor docs fixes #400

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
bprobert97 merged 2 commits into from
Aug 7, 2026
Merged

Minor docs fixes #400

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
0c1d7e5
Fix a syntax error in the public API docs.
rwb27 Aug 6, 2026
ae173eb
Fix links in contributing document
rwb27 Aug 6, 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
6 changes: 4 additions & 2 deletions docs/source/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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/
Expand Down
2 changes: 1 addition & 1 deletion docs/source/public_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Loading