diff --git a/.github/workflows/publish_docs.yml b/.github/workflows/publish_docs.yml index 39ed26d5..7568e3fe 100644 --- a/.github/workflows/publish_docs.yml +++ b/.github/workflows/publish_docs.yml @@ -15,10 +15,6 @@ jobs: uses: actions/setup-python@v3 with: python-version: 3 - - name: Install dependencies - run: | - python -m pip install --upgrade pip - if [ -f requirements.txt ]; then pip install -r requirements.txt; fi - name: Build Docs run: ./build.sh - name: Publish Docs diff --git a/build.sh b/build.sh index bf172e08..06d8283b 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" -# 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 simply 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 9153b4d7..5cdc2307 100755 --- a/examples/gen_readme.py +++ b/examples/gen_readme.py @@ -1,12 +1,13 @@ #!/usr/bin/env python3 """Generate the dockerfiles from a jinja template.""" +import os +import logging from pathlib import Path + from jinja2 import Environment, FileSystemLoader from markupsafe import Markup - -import os import yaml -import logging + log = logging.getLogger(__name__) diff --git a/examples/ok-with-mkdocstrings/module.grepout b/examples/ok-with-mkdocstrings/module.grepout index 6f5d86bc..bd64588e 100644 --- a/examples/ok-with-mkdocstrings/module.grepout +++ b/examples/ok-with-mkdocstrings/module.grepout @@ -9,7 +9,7 @@ documentation!
module.main()
+module.main()