Skip to content

Commit ee8c5eb

Browse files
committed
Fix some broken references in the docs.
1 parent 5727457 commit ee8c5eb

File tree

3 files changed

+8
-5
lines changed

3 files changed

+8
-5
lines changed

docs/source/actions.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,8 @@ The first is ``self`` (the first positional argument), which is always the
5858
supply resources needed by the action. Most often, this is a way of accessing
5959
other `.Things` on the same server.
6060

61-
.. action_logging:
61+
.. _action_logging:
62+
6263
Logging from actions
6364
--------------------
6465
Action code should use `.Thing.logger` to log messages. This will be configured
@@ -70,7 +71,8 @@ a long time to run, or it may simply be a helpful debugging aid.
7071

7172
See :mod:`.logs` for details of how this is implemented.
7273

73-
.. action_cancellation:
74+
.. _action_cancellation:
75+
7476
Cancelling actions
7577
------------------
7678
If an action could run for a long time, it is useful to be able to cancel it
@@ -82,7 +84,8 @@ is equivalent, but will raise an exception if the action is cancelled.
8284

8385
For more advanced options, see `.invocation_contexts` for detail.
8486

85-
.. invocation_context:
87+
.. _invocation_context:
88+
8689
Invocation contexts
8790
-------------------
8891
Cancelling actions and capturing their logs requires action code to use a

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Previous version
3434
----------------
3535

3636
This is a ground-up rewrite of python-labthings_, replacing Flask 1 and Marshmallow with FastAPI and Pydantic.
37-
Compared to `python-labthings`_, this framework updates dependencies, shrinks the codebase, and simplifies the API (see :doc:`lt_structure`).
37+
Compared to `python-labthings`_, this framework updates dependencies, shrinks the codebase, and simplifies the API (see :doc:`structure`).
3838
* FastAPI more or less completely eliminates OpenAPI generation code from our codebase
3939
* Marshmallow schemas and endpoint classes are replaced with Python type hints, eliminating double- or triple-definition of actions and their inputs/outputs.
4040
* Thing Description generation is very much simplified by the new structure (multiple Things instead of one massive Thing with many extensions)

docs/source/thing_slots.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. thing_slots:
1+
.. _thing_slots:
22

33
Thing Slots
44
===========

0 commit comments

Comments
 (0)