Add enhanced pydoc-markdown pre-hook #2979
Merged
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.
Related Issues
Proposed Changes:
Instead of building all the docs at every commit to ensure docs were updated, this pre-hook script will only try to build the API docs corresponding to the files actually changed, and skip the build altogether if the changed files aren't relevant for a documentation change.
How did you test it?
Just check out my branch, try changing a documented API and run
pre-commit
or try to actual make the commit.Notes for the reviewer
This check makes several assumptions:
search_path
field inside the pydoc config filessearch_path
arrayChecklist