From 7737bd21ae63e884914ca1b279823ef46d323267 Mon Sep 17 00:00:00 2001 From: Jovial Joe Jayarson Date: Wed, 29 Mar 2023 08:45:39 +0530 Subject: [PATCH] fix: `source .venv/bin/activate` before build - rename `mkdocs.yml` to `mkdocs.yaml` - same reflects in `docs/gen_docs.py` - activates virtual environment before build **Related items** *Issues* - Closes #253 - Closes #259 --- .github/workflows/build.yml | 4 +++- docs/gen_docs.py | 4 ++-- mkdocs.yml => mkdocs.yaml | 0 3 files changed, 5 insertions(+), 3 deletions(-) rename mkdocs.yml => mkdocs.yaml (100%) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 2e854e9b..9c3debb7 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -35,7 +35,9 @@ jobs: run: poetry install --no-interaction --no-ansi --only docs # build package - name: Build package - run: python build.py + run: | + source .venv/bin/activate + python build.py # publish package - name: Publish to PyPI uses: pypa/gh-action-pypi-publish@release/v1 diff --git a/docs/gen_docs.py b/docs/gen_docs.py index 31cc3359..354a2951 100644 --- a/docs/gen_docs.py +++ b/docs/gen_docs.py @@ -61,11 +61,11 @@ def generate_documentation(source: Path, discard_refs: bool = True): # generate reference documentation nav_items = _generate_reference(source / "validators/__init__.py", source / "docs/reference") # backup mkdocs config - _update_mkdocs_config(source / "mkdocs.yml", source / "mkdocs.bak.yml", nav_items) + _update_mkdocs_config(source / "mkdocs.yaml", source / "mkdocs.bak.yml", nav_items) # build docs as subprocess print(run(("mkdocs", "build"), capture_output=True).stderr.decode()) # restore mkdocs config - move(str(source / "mkdocs.bak.yml"), source / "mkdocs.yml") + move(str(source / "mkdocs.bak.yml"), source / "mkdocs.yaml") # optionally discard reference folder if discard_refs: rmtree(source / "docs/reference") diff --git a/mkdocs.yml b/mkdocs.yaml similarity index 100% rename from mkdocs.yml rename to mkdocs.yaml