Skip to content

Commit 5c51928

Browse files
committed
docs wip
1 parent cbee292 commit 5c51928

File tree

2 files changed

+26
-5
lines changed

2 files changed

+26
-5
lines changed

docs/Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33

44
# You can set these variables from the command line.
55
SPHINXOPTS =
6-
SPHINXBUILD = python3 -msphinx
6+
SPHINXBUILD = poetry run sphinx-build
77
SPHINXPROJ = lox
88
SOURCEDIR = .
9-
BUILDDIR = _build
9+
BUILDDIR = build
1010

1111
# Put it first so that "make" without argument is like "make help".
1212
help:

docs/modules.rst

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,28 @@
11
lox
22
===
33

4-
.. toctree::
5-
:maxdepth: 4
4+
.. autoclass:: lox.Announcement
65

7-
lox
6+
.. autoclass:: lox.Funnel
7+
8+
.. autoclass:: lox.IndexSemaphore
9+
10+
.. autoclass:: lox.LightSwitch
11+
12+
.. autoclass:: lox.QLock
13+
14+
.. autoclass:: lox.RWLock
15+
16+
.. autofunction:: lox.process
17+
18+
.. autofunction:: lox.thread
19+
20+
Exceptions
21+
^^^^^^^^^^
22+
.. autoclass:: lox.FunnelPutError
23+
24+
.. autoclass:: lox.FunnelPutTopError
25+
26+
.. autoclass:: lox.SubscribeFinalizedError
27+
28+
.. autoclass:: lox.Timeout

0 commit comments

Comments
 (0)