Set up initial Sphinx documentation and add Normalize filter docstrings #30
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.
This PR introduces the initial Sphinx documentation structure under the
docs/directory and sets up basic configuration for project-wide documentation. It includes:conf.pywith autodoc, napoleon, and viewcode extensions enabledindex.rstandmodules.rstfile to serve as a starting point for documentationpyproject.tomlto include Sphinx under optional dev dependenciessrc/scarr/filters/normalize.pyThis work aligns with the feedback provided in response to the original glossary proposal and fulfills the first step toward integrating full project documentation, as discussed in issue #26.
Let me know if you'd prefer a different layout or have other best practices to follow. Thanks for the opportunity to contribute!