Repository navigation
docs: API docs - #58
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR sets up Sphinx/Read the Docs documentation for the project and improves in-repo documentation/typing for the RFC 3987 grammar helpers.
Changes:
- Add Read the Docs configuration and a Sphinx documentation scaffold (conf, index, requirements, gitignore).
- Expand docstrings and typing in
syntax_helpers.py, and add clarifying comments in the Lark grammar. - Rework public exports by introducing a package-level
__all__.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| src/rfc3987_syntax2/syntax_rfc3987.lark | Adds grammar provenance and clarifies a helper token comment. |
| src/rfc3987_syntax2/syntax_helpers.py | Improves typing/docstrings and refactors validator/export-related code paths. |
| src/rfc3987_syntax2/init.py | Adds package __all__ and re-exports helper APIs. |
| docs/requirements.txt | Adds pinned-ish doc build dependencies for Sphinx/RTD. |
| docs/index.rst | Includes README via MyST and defines a toctree root. |
| docs/conf.py | Configures Sphinx + AutoAPI + MyST for the package. |
| docs/.gitignore | Ignores Sphinx build artifacts. |
| .readthedocs.yaml | Adds RTD build configuration. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.
Comments suppressed due to low confidence (1)
.readthedocs.yaml:11
- Read the Docs config expects an explicit Ubuntu release (e.g. ubuntu-24.04) and a supported Python toolchain version;
ubuntu-lts-latestis not a documentedbuild.osvalue, andpython: "3.14"is not listed in the RTD config examples. This is likely to fail config validation and break the docs build.
build:
os: ubuntu-lts-latest
tools:
python: "3.14"
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.
Comments suppressed due to low confidence (1)
src/rfc3987_syntax2/syntax_helpers.py:124
- The docstring references :func:
check, but no such function exists in this module. This will create broken cross-references in generated docs; it likely meant :func:is_valid_syntax.
"""Top-level RFC 3987 parser start terms accepted by :func:`parse` and :func:`check`.
Collaborator
Author
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.
No description provided.