Repository navigation
Conversation
Move the guide out of the README into Sphinx pages written in Markdown with MyST, using the Furo theme, and add an API reference generated from the docstrings. .readthedocs.yaml installs the new docs dependency group with uv and fails the build on warnings, and a CI job builds the docs the same way. The README is now a quick start that links to the documentation. LookupWidget's docstring explains its arguments.
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
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.
Summary
The README had grown into the full guide. This moves the guide into Sphinx documentation for Read the Docs, at https://izaya.readthedocs.io/, and shortens the README to a quick start that links to it.
docs/: Sphinx pages written in Markdown with MyST, using the Furo theme. Installation, usage, private data, styling and JavaScript are moved from the README with their wording unchanged. There are also pages for the example project, development and the changelog, which includesCHANGELOG.md.docs/api.md: an API reference generated from the docstrings forregister,Lookup,ModelLookup,ItemandLookupWidget. It also covers theIZAYA_CLASSESandIZAYA_LOGIN_REQUIREDsettings and theizaya.E001andizaya.W001system checks..readthedocs.yaml: installs the newdocsdependency group with uv on Python 3.14, and fails the build on any warning.testing.yml: a newDocsjob builds the documentation withsphinx-build -W, so a change that breaks the docs fails CI.LookupWidget's docstring now explainslookup,multipleandclasses, including thatclassesreplaces theIZAYA_CLASSESvalue for each key it sets.pyproject.tomladds aDocumentationproject URL.To build the documentation locally: