Regenerate API documentation and standardise Google-style docstrings#283
Merged
harryswift01 merged 4 commits intomainfrom Feb 26, 2026
Merged
Regenerate API documentation and standardise Google-style docstrings#283harryswift01 merged 4 commits intomainfrom
harryswift01 merged 4 commits intomainfrom
Conversation
jimboid
approved these changes
Feb 26, 2026
Member
jimboid
left a comment
There was a problem hiding this comment.
An important iteration on the API, keeping it updated with the codebase until we redesign the interface later. The docstrings being standardised is a great step to keeping the code in a maintainable state. The proper naming of CI is a nice addition here too which helps to keep things understandable in the process side of things. Please go ahead and merge.
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
This PR regenerates the API documentation following the recent internal restructuring of CodeEntropy and standardises all docstrings to Google-style format. It also resolves multiple Sphinx build warnings and introduces tooling to prevent future documentation regressions.
Changes
Documentation Regeneration
docs/api.rstwith generateddocs/api/module pages.index.rstand FAQ references to align with the new layout.Docstring Standardisation
Tooling & CI Improvements
conf.pyto fully support Google-style docstrings via napoleon.rstcheckto pre-commit for docstring validation.Impact