Replace pre-commit with Tox and Fix Documentation Generation #133
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.
Replace pre-commit with Tox and Fix Documentation Generation
Description
This Pull Request introduces the following major changes to the repository:
Replaced pre-commit with Tox:
.pre-commit-config.yaml
file and all related configurations.tox.ini
file for managing:py38
,py39
,py310
,py311
,py312
).flake8
,black
, andisort
.mypy
.codespell
.Fixed Sphinx Documentation Generation:
_templates/autosummary/module.rst
, ensuring proper formatting and resolvingdoc8
validation errors.tox.ini
to handle Sphinx builds seamlessly with dependencies likedoc8
,nbsphinx
, andIPython
.make clean html
.Key Changes
Removed Files:
.pre-commit-config.yaml
(no longer required as Tox replaces its functionality).Added/Updated Files:
tox.ini
:Dependencies Updated:
pyproject.toml
to reflect dependencies required for Tox and documentation generation.How to Test