Skip to content

Commit

Permalink
Updates to work with the latest version
Browse files Browse the repository at this point in the history
  • Loading branch information
lbutler committed Dec 5, 2024
1 parent a84832d commit 0cc4e6f
Show file tree
Hide file tree
Showing 7 changed files with 36 additions and 16 deletions.
16 changes: 14 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,4 @@ yarn-error.log*

# python virtual environmentß
/epanet-js-website
/epanet-js-website-v2
8 changes: 4 additions & 4 deletions docs/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
9 changes: 5 additions & 4 deletions docs/blog/.authors.yml
Original file line number Diff line number Diff line change
@@ -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
4 changes: 2 additions & 2 deletions docs/blog/posts/compile-epanet-gui.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"}

<figure markdown>
![EPANET Source Code Location](/assets/blog/compile-epanet-gui/1-download-source-code.png){: style="max-width:400px" }
Expand All @@ -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"}

<figure markdown>
![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);"}
Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
10 changes: 8 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,16 @@

The epanet-js website is created using Material for MkDocs.

### install

```
pip install git+https://{GH_TOKEN}@github.com/squidfunk/[email protected]
```

### 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
```

0 comments on commit 0cc4e6f

Please sign in to comment.