Add Sphinx docs and improve code documentation (#1)#2
Merged
Conversation
Add Sphinx documentation configuration and build workflow, updates .gitignore for Sphinx outputs, and enhances docstrings and type annotations across core modules. The README is updated with PyPI badges and install instructions. The CI workflow now tests Python 3.13 and 3.14. The pyproject.toml version is bumped to 0.2.0a1 and Sphinx is added as a dev dependency. Code in core modules is refactored for clarity, with improved docstrings, type hints, and minor API cleanups.
Removes Python 3.14 from the GitHub Actions CI matrix and from the project classifiers in pyproject.toml to align supported versions.
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
1 participant
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.
Add Sphinx documentation configuration and build workflow, updates .gitignore for Sphinx outputs, and enhances docstrings and type annotations across core modules. The README is updated with PyPI badges and install instructions. The CI workflow now tests Python 3.13 and 3.14. The pyproject.toml version is bumped to 0.2.0a1 and Sphinx is added as a dev dependency. Code in core modules is refactored for clarity, with improved docstrings, type hints, and minor API cleanups.