Last active
May 31, 2021 13:29
-
-
Save LouisdeBruijn/37ba72d2b8cf9e947b6e9d7020f8e0ce to your computer and use it in GitHub Desktop.
pre-commit hooks for docstrings documentation and MkDocs build
This file contains 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
- id: automate_functions | |
name: Add functions to mkgendocs configurations YAML | |
entry: bash -c "python3 Python\ tips/automate.py; git add -u" -- | |
language: system | |
- id: mkgendocs | |
name: Generate markdown from docstrings | |
entry: bash -c "gendocs --config 'mkgendocs.yml'; git add -u" -- | |
language: system | |
- id: mkbuild | |
name: Build the markdown documentation, run with '$ mkdocs serve' at http://127.0.0.1:8000/ | |
entry: bash -c 'mkdocs build' | |
language: system |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment