Merged
Conversation
- Move Sphinx build commands from docs/sphinx/Makefile to main Makefile - Add Sphinx variables (SPHINXBUILD, SOURCEDIR, BUILDDIR) to main Makefile - Update docs and docs-clean targets to call sphinx-build directly - Enhance clean target to include Sphinx documentation cleanup
- Add pre-commit hook in .githooks/ directory that runs: - Auto-formatting with black and isort - Linting with flake8 - Type checking with mypy - Full test suite with pytest - Add 'make setup-hooks' command to configure git hooks path - Use core.hooksPath approach for version-controlled hooks
- Remove docs-clean target from main Makefile (clean command handles everything) - Delete docs/sphinx/Makefile (all functionality moved to main Makefile) - Update clean command description to reflect it cleans all artifacts
- Add docs-linkcheck target to Makefile - Update GitHub workflow to use make docs instead of cd docs/sphinx && make html - Update linkcheck to use make docs-linkcheck - Fixes CI build failure after removing docs/sphinx/Makefile
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
Changes
Makefile Improvements
Pre-commit Hook
Setup
Developers need to run make setup-hooks once after cloning to enable the pre-commit hook.
Test plan