From 0cc4e6f1a7de3b820c522895cfb101bab9ce54dc Mon Sep 17 00:00:00 2001 From: lbutler Date: Thu, 5 Dec 2024 15:30:38 +1100 Subject: [PATCH] Updates to work with the latest version --- .github/workflows/ci.yml | 16 ++++++++++++++-- .gitignore | 1 + docs/api/index.md | 8 ++++---- docs/blog/.authors.yml | 9 +++++---- docs/blog/posts/compile-epanet-gui.md | 4 ++-- mkdocs.yml | 4 ++-- readme.md | 10 ++++++++-- 7 files changed, 36 insertions(+), 16 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 683ae5f..b223477 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -11,10 +11,22 @@ jobs: runs-on: ubuntu-latest if: github.event.repository.fork == false steps: - - uses: actions/checkout@v3 - - uses: actions/setup-python@v4 + - uses: actions/checkout@v4 + - name: Configure Git Credentials + run: | + git config user.name github-actions[bot] + git config user.email 41898282+github-actions[bot]@users.noreply.github.com + - uses: actions/setup-python@v5 with: python-version: 3.x + - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV + - uses: actions/cache@v4 + with: + key: mkdocs-material-${{ env.cache_id }} + path: .cache + restore-keys: | + mkdocs-material- + #- run: apt-get install pngquant - run: pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git - run: mkdocs gh-deploy --force env: diff --git a/.gitignore b/.gitignore index be7f7fe..fbe6987 100755 --- a/.gitignore +++ b/.gitignore @@ -21,3 +21,4 @@ yarn-error.log* # python virtual environmentß /epanet-js-website +/epanet-js-website-v2 diff --git a/docs/api/index.md b/docs/api/index.md index e107390..e70177b 100755 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -17,7 +17,7 @@ If you are not familiar with the OWA-EPANET Toolkit API or EPANET it is worthwhi ** List of Classes ** -| Class | Description | -| ------------------------ | ----------------------------------------------------------------------------------------------- | -| [Workspace](./workspace) | A virtual file system where you can store and read files that are consumed by the tool kit | -| [Project](./project) | A single instance of the EN_Project wrapper object and a singleton with all 122 toolkit methods | +| Class | Description | +| --------------------------- | ----------------------------------------------------------------------------------------------- | +| [Workspace](./workspace.md) | A virtual file system where you can store and read files that are consumed by the tool kit | +| [Project](./project.md) | A single instance of the EN_Project wrapper object and a singleton with all 122 toolkit methods | diff --git a/docs/blog/.authors.yml b/docs/blog/.authors.yml index 0399d20..5774699 100644 --- a/docs/blog/.authors.yml +++ b/docs/blog/.authors.yml @@ -1,4 +1,5 @@ -lbutler: - name: Luke Butler - description: epanet-js maintainer - avatar: https://s.gravatar.com/avatar/33e08ddc8e6921ecf6416baa9931404a?s=80 +authors: + lbutler: + name: Luke Butler + description: epanet-js maintainer + avatar: https://s.gravatar.com/avatar/33e08ddc8e6921ecf6416baa9931404a?s=80 diff --git a/docs/blog/posts/compile-epanet-gui.md b/docs/blog/posts/compile-epanet-gui.md index fce5a53..0ecb0f9 100644 --- a/docs/blog/posts/compile-epanet-gui.md +++ b/docs/blog/posts/compile-epanet-gui.md @@ -21,7 +21,7 @@ Thanks to Oscar Vegas Niño for creating a [guide in Spanish](https://www.resear First, download the EPANET 2.2 programmer’s toolkit and the source code files from the EPANET website. Extract these zip files to your local drive. -** Download: ** [:octicons-link-external-16: EPANET Source Code](https://www.epa.gov/water-research/epanet){:target="\_blank"} +**Download:** [:octicons-link-external-16: EPANET Source Code](https://www.epa.gov/water-research/epanet){:target="\_blank"}
![EPANET Source Code Location](/assets/blog/compile-epanet-gui/1-download-source-code.png){: style="max-width:400px" } @@ -32,7 +32,7 @@ First, download the EPANET 2.2 programmer’s toolkit and the source code files The EPANET GUI is written in Pascal, so you will need to download the Delphi Community Edition from the Embarcadero website. You will need to register and provide your email address to receive a serial code. -** Download: ** [:octicons-link-external-16: Delphi Community Edition](https://www.embarcadero.com/products/delphi/starter/free-download){:target="\_blank"} +**Download:** [:octicons-link-external-16: Delphi Community Edition](https://www.embarcadero.com/products/delphi/starter/free-download){:target="\_blank"}
![Delphi Community Edition Download](/assets/blog/compile-epanet-gui/2-register.png){style="border:1px solid #e5e5e5;box-shadow: 0px 10px 20px -6px rgba(0,0,0,0.1);"} diff --git a/mkdocs.yml b/mkdocs.yml index f7661b7..8451813 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -61,8 +61,8 @@ markdown_extensions: - attr_list - md_in_html - pymdownx.emoji: - emoji_index: !!python/name:materialx.emoji.twemoji - emoji_generator: !!python/name:materialx.emoji.to_svg + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg - toc: permalink: true diff --git a/readme.md b/readme.md index d371f2e..d0c10fa 100644 --- a/readme.md +++ b/readme.md @@ -2,10 +2,16 @@ The epanet-js website is created using Material for MkDocs. +### install + +``` +pip install git+https://{GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git@9.4.2-insiders-4.42.0 +``` + ### mkdocs commands ``` -$ python3 -m venv epanet-js-website -$ source epanet-js-website/bin/activate +$ python -m venv epanet-js-website-v2 +$ source epanet-js-website-v2/bin/activate $ mkdocs serve ```