Add mkdocs documentation site#25
Merged
patrick-kidger merged 1 commit intopatrick-kidger:mainfrom Apr 4, 2026
Merged
Conversation
patrick-kidger
force-pushed
the
add-documentation
branch
from
de3e52a to
f27915c
Compare
patrick-kidger
force-pushed
the
add-documentation
branch
from
f27915c to
21d5eb2
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a proper documentation site using mkdocs-material, analogous to the other libraries (wadler_lindig, jaxtyping, diffrax, equinox, etc.).
Changes:
mkdocs.yml: mkdocs-material configuration following the same pattern as the other libraries (theme, plugins, nav, etc.).docs/: documentation pages:index.md: landing page with intro, installation, quick example.api/basic.md: loops, threading, sleeping, error propagation (with mkdocstrings references).api/synchronisation.md: as_completed, Barrier, Event, Lock, Semaphore, timeout, TimeoutError.api/patterns.md: async context managers and async iterators.api/integrations.md: to/from asyncio and trio.api/isolate.md: isolate and copy.faq.md: the existing FAQ content._static/,_overrides/,.htaccess: standard supporting files.README.md: trimmed to intro + installation + link to docs + collapsed FAQ. All inline documentation removed.