diff --git a/build.sh b/build.sh index fc806f2b..2ab6b207 100755 --- a/build.sh +++ b/build.sh @@ -3,13 +3,7 @@ set -e pip install -r requirements.txt pip install -e . # md file="build.snippet" content="^#?\s?(.*)" -# Building this package requires generating the readme files for the examples. -# -# ```bash -./examples/gen_readme.py -# ``` -# -# And then using `mkdocs_simple_gen` to generate the site. +# Building this package requires using `mkdocs_simple_gen` to generate the site. # ```bash mkdocs_simple_gen --build -- --verbose # ``` diff --git a/examples/gen_readme.py b/examples/gen_readme.py index d8b8a856..117d4bbf 100755 --- a/examples/gen_readme.py +++ b/examples/gen_readme.py @@ -187,7 +187,7 @@ def output_criteria(path): os.system(f"rm -rf {folder}/site {folder}/mkdocs.yml") -def generate(*args, **kwargs): +def on_startup(*args, **kwargs): """Generate all of the readmes""" file_loader = FileSystemLoader('.') env = Environment(loader=file_loader) @@ -212,4 +212,4 @@ def include_file(name): if __name__ == "__main__": - generate() + on_startup() diff --git a/mkdocs.yml b/mkdocs.yml index 2fd62d00..927c6a0f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,6 +6,8 @@ plugins: - macros - search - mike +hooks: + - examples/gen_readme.py edit_uri: '' site_url: https://althack.dev/mkdocs-simple-plugin repo_url: https://github.com/athackst/mkdocs-simple-plugin