Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge dev into main #61

Open
wants to merge 559 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
559 commits
Select commit Hold shift + click to select a range
8a61466
Merge pull request #44 from standerstv/patch-1
tmhastings Jun 28, 2024
55685f2
Update Configure.md
tmhastings Jun 28, 2024
513a6dc
Merge pull request #37 from MikePlante1/pdf
aug0211 Jun 28, 2024
f7e2b5e
Update transition-qa.md
tmhastings Jun 28, 2024
9919744
add white border to logo
MikePlante1 Jun 28, 2024
24a68f9
Merge pull request #36 from MikePlante1/logo
tmhastings Jun 28, 2024
7df5a85
Update Overview.md
tmhastings Jun 28, 2024
7c3d1d7
Update Overview.md
tmhastings Jun 28, 2024
731f93d
Remove section for changes to Apple Crown rotation
snickerdoodleparent Jun 28, 2024
e17b524
Update cgm.md
tmhastings Jun 28, 2024
605f12d
Update iphone.md
tmhastings Jun 28, 2024
2ceffe9
Add Xcode Behaviors
marionbarker Jun 29, 2024
3a1bbdf
fix typo
marionbarker Jun 29, 2024
8b8957c
Merge pull request #49 from snickerdoodleparent/patch-2
MikePlante1 Jun 30, 2024
6b4db1e
Update transition-qa.md
tmhastings Jun 30, 2024
9d1f029
Update index.md
tmhastings Jun 30, 2024
99af393
Update New-User-Setup.md
tmhastings Jun 30, 2024
ba40664
Update New-User-Setup.md
tmhastings Jun 30, 2024
caac736
Update New-User-Setup.md
tmhastings Jun 30, 2024
156a09c
Update index.md
tmhastings Jun 30, 2024
b4a2d19
Update index.md
tmhastings Jun 30, 2024
bd73f54
Update index.md
tmhastings Jun 30, 2024
0c74d8a
Update Xcode Behaviors section and add graphic
marionbarker Jul 2, 2024
fd0bcaa
fix typo
marionbarker Jul 2, 2024
73f6bac
Merge branch 'dev' into build_update_pr-297
marionbarker Jul 2, 2024
f53123b
Merge pull request #48 from tmhastings/Restructure-Docs-Menu
tmhastings Jul 2, 2024
5c82f77
Update citations.md
tmhastings Jul 3, 2024
db7fdc4
Update citations.md
tmhastings Jul 3, 2024
8c2db6b
simplify the submodule steps
marionbarker Jul 8, 2024
075e250
Merge branch 'dev' into build_update_pr-297
marionbarker Jul 8, 2024
3de7fd6
remove explicit width for png files, fix typo
marionbarker Jul 8, 2024
f22e2ee
remove _blank and fix missing backtick
marionbarker Jul 9, 2024
abf0901
Update citations.md
tmhastings Jul 10, 2024
5a2b30f
Update carbratios.md
tmhastings Jul 10, 2024
40b590c
Update insulinsensitivities.md
tmhastings Jul 10, 2024
7897125
Update nightscout.md
tmhastings Jul 10, 2024
8749196
Update autosens-dynamic.md
tmhastings Jul 10, 2024
9bd123a
Update build.md
tmhastings Jul 10, 2024
f819b9e
Update trio.md
tmhastings Jul 10, 2024
38d2ff9
Update dynamicsettings.md
tmhastings Jul 10, 2024
e0f17ba
Update fatprotein.md
tmhastings Jul 10, 2024
39cc861
Update autosens-dynamic.md
tmhastings Jul 10, 2024
44ce52e
Update pumpsettings.md
tmhastings Jul 10, 2024
39c0317
Update carbratios.md
tmhastings Jul 10, 2024
29c8691
Update build.md
tmhastings Jul 10, 2024
40ea1b6
Update build.md
tmhastings Jul 10, 2024
f543414
Delete docs/EN/resources/img/compare.png
tmhastings Jul 10, 2024
712715d
Update troubleshoot.md
tmhastings Jul 10, 2024
3405060
Update dynamicsettings.md
tmhastings Jul 10, 2024
1e2ec73
Update troubleshoot.md
tmhastings Jul 10, 2024
341fe36
Update troubleshoot.md
tmhastings Jul 10, 2024
3c1dd71
Update insulinsensitivities.md
tmhastings Jul 10, 2024
734ace9
Update trio.md
tmhastings Jul 10, 2024
aeb6ad1
Update mainsettings.md
tmhastings Jul 10, 2024
2010808
Update mainsettings.md
tmhastings Jul 10, 2024
a967fa9
Update mainsettings.md
tmhastings Jul 10, 2024
0ffea59
Update autosens-dynamic.md
tmhastings Jul 10, 2024
386e51d
Update mainsettings.md
tmhastings Jul 10, 2024
a14f7f0
Update autosens-dynamic.md
tmhastings Jul 10, 2024
d6ed91e
Update dynamicsettings.md
tmhastings Jul 10, 2024
ee58798
Update cgm.md
tmhastings Jul 10, 2024
028a18c
fix typo for TEAMID
marionbarker Jul 10, 2024
0298a88
Merge branch 'dev' into LnL-edits
tmhastings Jul 10, 2024
62febbd
Update index.md
tmhastings Jul 11, 2024
6a145bc
Update index.md
tmhastings Jul 11, 2024
e139e79
Update New-User-Setup.md
tmhastings Jul 11, 2024
541347f
fix typos, fix link, modify header levels
marionbarker Jul 11, 2024
357fdf0
Update build.md
tmhastings Jul 11, 2024
b91152c
Update transition-qa.md
tmhastings Jul 11, 2024
78703d5
Update cgm.md
tmhastings Jul 11, 2024
fc98677
Update pump.md
tmhastings Jul 11, 2024
c4e2376
Update troubleshoot.md
tmhastings Jul 11, 2024
15854e1
Update cgm.md
tmhastings Jul 11, 2024
3dc3ad1
Add files via upload
tmhastings Jul 11, 2024
2e4b67b
Delete docs/EN/Setup/img/Backfill Glucose.png
tmhastings Jul 11, 2024
739c27f
Delete docs/EN/Setup/img/Connect to Nightscout.png
tmhastings Jul 11, 2024
5edc3e4
Delete docs/EN/Setup/img/Connect.png
tmhastings Jul 11, 2024
3b973d1
Delete docs/EN/Setup/img/Glucose Units.png
tmhastings Jul 11, 2024
3ced3af
Delete docs/EN/Setup/img/Import Settings.png
tmhastings Jul 11, 2024
f4a806d
Delete docs/EN/Setup/img/Nightscout Menu.png
tmhastings Jul 11, 2024
988b1e1
Delete docs/EN/Setup/img/Preferences.png
tmhastings Jul 11, 2024
d3c4600
Create img folder for Configuration
tmhastings Jul 11, 2024
def603b
Add files via upload
tmhastings Jul 11, 2024
d63da04
Delete docs/EN/Configuration/img directory
tmhastings Jul 11, 2024
256181b
Update cgm.md
tmhastings Jul 11, 2024
d14a9b3
clarify customization steps for CLI
marionbarker Jul 11, 2024
05d1fd3
fix instructions for Xcode Behaviors with graphics
marionbarker Jul 11, 2024
c51a7aa
clarify open terminal language
marionbarker Jul 11, 2024
d650ad3
Merge pull request #52 from tmhastings/LnL-edits
tmhastings Jul 12, 2024
2a67943
Merge pull request #47 from loopandlearn/build_update_pr-297
MikePlante1 Jul 12, 2024
2eac7b0
modify cgm page, GlucoseDirect does not support Trio App Group at thi…
marionbarker Jul 12, 2024
44d83a3
Add information for Trio App Group, improve update with mac-xcode ins…
marionbarker Jul 13, 2024
77ed666
add Top of Page link to indicate end of task in section
marionbarker Jul 15, 2024
04e6277
incorporate reviewer comments
marionbarker Jul 15, 2024
806ade2
Merge pull request #54 from loopandlearn/updates_pr_314
MikePlante1 Jul 16, 2024
0c5f0b5
Update insulinsensitivities.md
tmhastings Jul 24, 2024
6b57324
Merge pull request #55 from tmhastings/ISF-Docs-Update
tmhastings Jul 24, 2024
793535c
Update minimum iOS to 16
MikePlante1 Jul 29, 2024
865b3c9
add iPhone 15 to list
MikePlante1 Jul 29, 2024
55fc405
update links for LoopDocs
MikePlante1 Aug 1, 2024
f944e19
point to LoopDocs Browser Overview instead of Browser Introduction
MikePlante1 Aug 1, 2024
ec41ee3
Merge pull request #56 from MikePlante1/min_ios
MikePlante1 Aug 1, 2024
1644f25
Merge pull request #57 from MikePlante1/ld_update
MikePlante1 Aug 1, 2024
029dab1
update for release: point to main branch for testflight.md
marionbarker Aug 13, 2024
ba1bf5e
Improve the build instructions
marionbarker Aug 14, 2024
3c2a29f
incorporate reviewer comments
marionbarker Aug 14, 2024
4102874
Merge pull request #58 from loopandlearn/add_main_branch
MikePlante1 Aug 16, 2024
148ae13
Make links relative instead of absolute paths, fixes broken links to
bniels707 Aug 21, 2024
1d853e0
Merge pull request #59 from bniels707/index-linkref-fixes
tmhastings Aug 22, 2024
e555e51
Fix `14 day` TDD avg for DynISF to `10 day`
MikePlante1 Aug 29, 2024
bbc1e64
clarify Max IOB suggestion
MikePlante1 Sep 11, 2024
b9e2f68
Merge pull request #60 from MikePlante1/10-day
MikePlante1 Sep 16, 2024
c2ee143
Formatting and link fixes
bniels707 Sep 24, 2024
2804c84
Merge pull request #64 from bniels707/formatting-and-link-fixes
tmhastings Sep 24, 2024
2fe59d9
✏️ Fix typos
ebouchut Sep 24, 2024
024bd32
✏️ Fix typo and revise sentence
ebouchut Sep 24, 2024
197663b
✏️ Fix typo: Add backticks (inline code block) where missing
ebouchut Sep 24, 2024
8501a17
📝 Update README
ebouchut Sep 25, 2024
c86d5c4
✏️ Fix language of code block in README
ebouchut Sep 25, 2024
1f03432
Merge pull request #65 from ebouchut/fix/typos
MikePlante1 Sep 25, 2024
cb25804
Update Overview.md
Natolida Sep 28, 2024
a499a91
Update New-User-Setup.md
Natolida Sep 28, 2024
9d15479
Update transition-qa.md
Natolida Sep 28, 2024
e796a3f
Update transition-qa.md
Natolida Sep 28, 2024
f196af1
Update troubleshoot.md
Natolida Sep 29, 2024
6264b5f
🙈 Git now ignores docs/_build/
ebouchut Sep 27, 2024
abf4846
🙈 Git now ignores venv/
ebouchut May 10, 2024
3079fee
Merge pull request #1 from Natolida/patch-4
Natolida Sep 29, 2024
409b506
Merge pull request #2 from Natolida/patch-1
Natolida Sep 29, 2024
0474a44
Merge pull request #3 from Natolida/patch-2
Natolida Sep 29, 2024
7392293
Merge pull request #4 from Natolida/patch-5
Natolida Sep 30, 2024
59944f6
🚸 Add page navigation with arrow keys
ebouchut Sep 29, 2024
bdd8415
Merge pull request #71 from Natolida/dev
MikePlante1 Sep 30, 2024
8a11e0f
Merge pull request #72 from ebouchut/config/sphinx_add_page_navigatio…
MikePlante1 Sep 30, 2024
25c3fad
Merge pull request #70 from ebouchut/config/gitignore
MikePlante1 Sep 30, 2024
b40210a
✏️ Fix typo in the example of Max Daily Safety Multiplier
ebouchut Oct 2, 2024
ee38f79
Merge pull request #76 from ebouchut/fix/typo-max_daily_safety_multip…
MikePlante1 Oct 2, 2024
70dbb30
✏️ Fix typo in `Recommended Bolus Percentage` default value
ebouchut Oct 2, 2024
d0acdfa
Merge pull request #78 from ebouchut/fix/typo-default_recommended_bol…
MikePlante1 Oct 2, 2024
dc038b7
🔧 Move direct dependencies to requirements.in
ebouchut Oct 3, 2024
36a83b7
➕ Add new dependency sphinx-new-tab-link
ebouchut Oct 3, 2024
ef390e7
📝 Fix admonitions
ebouchut Oct 4, 2024
ed4f3e7
🌐 Add a translation page
ebouchut Oct 4, 2024
64719ab
➕ Add sphinx-autobuild dependency
ebouchut Sep 30, 2024
a8b82cc
📝 Document how to install and preview changes locally
ebouchut Sep 30, 2024
b79cbe7
📌 Improve dependencies files (now 3 files)...
ebouchut Oct 11, 2024
d506032
🙈 Update .gitignore file
ebouchut Oct 1, 2024
1f55ec4
🔧 Add config files for mkdocs-translate
ebouchut Oct 1, 2024
f6a1622
🔧 Fix default mkdocs config file
ebouchut Oct 1, 2024
0052f24
💄 Mkdocs now uses Trio's logo and favicon
ebouchut Oct 11, 2024
23dc86d
🔧 Update Mkdocs config file
ebouchut Oct 1, 2024
36d6887
💄 Configure Mkdocs theme colors
ebouchut Oct 11, 2024
2d3fba3
🏗️ Switch admonitions syntax to Mkdocs from Sphinx
ebouchut Oct 11, 2024
04989b6
💄 Add new admonition type: important
ebouchut Oct 11, 2024
6c5ab4b
📝 Add an empty line after headings where missing
ebouchut Oct 11, 2024
06aef83
🏗️ Now use Mkdocs syntax to include images
ebouchut Oct 11, 2024
a848682
🏗️ Migrate admonitions to Mkdocs syntax
ebouchut Oct 11, 2024
0c1dd8b
🔧 Add social icons and links to Mkdocs Config
ebouchut Oct 7, 2024
293f2d9
🔧 Add a Table Of Contents (TOC) to Mkdocs config
ebouchut Oct 11, 2024
d9d0d52
🔧 Remove homepage from Mkdocs config
ebouchut Oct 8, 2024
ba66741
🍱 Add images to version control
ebouchut Oct 11, 2024
5528fbe
📝 Remove useless line breaks `<br>`
ebouchut Oct 11, 2024
8b358b8
🏗️ ➕ Migrate mathematical formulas to Mkdocs from Sphinx
ebouchut Oct 11, 2024
91ce4af
✏️ Use Markdown syntax instead of HTML tags
ebouchut Oct 11, 2024
3822e12
✏️ Fix typos and use inline block code where needed
ebouchut Oct 11, 2024
337a9e9
✏️ Fix Markdown lists
ebouchut Oct 11, 2024
bb88ca9
🔧 Add automatic theme and fix icons of theme switcher
ebouchut Oct 9, 2024
4e2a74c
🔧 Add author and copyright to configuration file
ebouchut Oct 10, 2024
118aa3c
⚰️ Remove Sphinx files
ebouchut Oct 10, 2024
dbc0b91
🔧 Add mermaid support to Mkdocs config
ebouchut Oct 10, 2024
e41cf1d
🏗️ Migrate copy-button to Mkdocs from Sphinx
ebouchut Oct 11, 2024
b114f58
⚰️ Remove translation file now that Sphinx to Mkdocs translation is done
ebouchut Oct 11, 2024
b7f6255
🔧 Fix table of Contents (TOC)
ebouchut Oct 11, 2024
50fd129
🚚 Move global assets to `assets/` from `EN/assets`
ebouchut Oct 11, 2024
4a9c9fb
🔧 List files not in navigation
ebouchut Oct 11, 2024
f575f0a
🔥 Remove duplicate favicon and logo
ebouchut Oct 11, 2024
8c84c04
✏️ Fix links
ebouchut Oct 11, 2024
0499499
✏️ Add missing line breaks
ebouchut Oct 11, 2024
d8106a7
🔧 Use friendly URLs
ebouchut Oct 11, 2024
5f1004f
🔧 Remove version and release fomr config file
ebouchut Oct 11, 2024
47a53d9
🔧 Fix Logo URL
ebouchut Oct 11, 2024
b9d25f5
🚚 Remove the EN folder
ebouchut Oct 12, 2024
2c72962
👷 Add CD workflow to deploy the site to GitHub Pages
ebouchut Oct 12, 2024
dcc1e72
👷 🗑️ Configure CD temporarily to build and deploy this feature branch
ebouchut Oct 12, 2024
acbf3b8
👷 Do not deploy if README is the only file changed.
ebouchut Oct 12, 2024
133ac92
📝 Update README: Add new sections: Install, Run, and Contribute
ebouchut Oct 12, 2024
ab87c68
⚰️ Remove unused plugins
ebouchut Oct 13, 2024
7a3f07e
➕ Add dependency: mkdocs-exporter
ebouchut Oct 16, 2024
8f42612
⚰️ 🔥 Remove unused image
ebouchut Oct 14, 2024
6264012
💄 Add the Trio logo to the front page of the Trio Doc PDF
ebouchut Oct 14, 2024
521594d
📝 Add a link to download the latest Trio Doc PDF
ebouchut Oct 14, 2024
a42e286
🚸 Open external links in a new window
ebouchut Oct 16, 2024
937a491
🔧 Add trio version number to the PDF
ebouchut Oct 15, 2024
01519cc
⏪️ Revert "👷 🗑️ Configure CD temporarily to build and deploy this fea…
ebouchut Oct 16, 2024
9b97155
📝 Update README: Add how to build the website and PDF locally
ebouchut Oct 16, 2024
ed6c91c
📝 Update README: Document how to migrate admonitions to Mkdocs from S…
ebouchut Oct 17, 2024
8a4a288
💄 Update theme colors (purple + light blue)
ebouchut Oct 17, 2024
b371982
💬 Change Site Name
ebouchut Oct 17, 2024
e65f633
🚸 Move top-level navigation headings to top row
ebouchut Oct 17, 2024
9c751b3
🚸 Enable search suggestions
ebouchut Oct 17, 2024
6a44eeb
🚸 Highlight all occurrences of searched terms
ebouchut Oct 17, 2024
dbda45e
🚸 Move page headers from left panel(TOC) to right panel
ebouchut Oct 17, 2024
b2a3e59
📝 Update Table of Contents (TOC)
ebouchut Oct 17, 2024
2053a9e
💄 Add the Trio logo to the home page
ebouchut Oct 17, 2024
8ab8b6c
💄 Resize the Logo logo on the home page
ebouchut Oct 17, 2024
e990cc6
✏️ Fix GitHub admonitions
ebouchut Oct 17, 2024
bb34691
✏️ Fix typo in `Recommended Bolus Percentage` default value
ebouchut Oct 2, 2024
84cdb22
✏️ Fix typo in the example of Max Daily Safety Multiplier
ebouchut Oct 2, 2024
9b7c0bc
✏️ Add missing newline before the list
ebouchut Oct 17, 2024
d28f387
🏗️ Convert details HTML tags to expandable admonitions
ebouchut Oct 17, 2024
ef64dbc
💄 Set theme primary color to deep purple
ebouchut Oct 17, 2024
0b06036
💄Add up-right arrow next to external links in the main body
ebouchut Oct 18, 2024
fea7f35
✏️ Fix typo in Table of Contents
ebouchut Oct 19, 2024
1bae322
Merge pull request #62 from MikePlante1/clarification-on-smb-uam-page
tmhastings Oct 20, 2024
a7c89c6
Merge pull request #80 from ebouchut/doc/add_translations_page
tmhastings Oct 20, 2024
ed9b2eb
Merge pull request #74 from ebouchut/config/sphinx-autobuild
tmhastings Oct 20, 2024
3eda6e9
💄Display right-up arrow next to external links with readthedocs theme
ebouchut Oct 20, 2024
eee4d63
🔧 Add CNAME containing the custom DNS domain
ebouchut Oct 21, 2024
160bebb
Fix Typo in `Max Daily Safety Multiplier`
ebouchut Oct 21, 2024
b7303c4
Merge pull request #84 from ebouchut/patch-1
MikePlante1 Oct 21, 2024
15e2f1a
🚸 Customize 404 page
ebouchut Oct 21, 2024
84ec314
🔧 Fix site_url and sitemaps.xml
ebouchut Oct 21, 2024
09bd47e
Merge PR 62
ebouchut Oct 21, 2024
b446709
Merge PR #80: 🌐 Add a translation page
ebouchut Oct 22, 2024
238a598
Merge PR #74: 👷 Automate the build and local preview of the website
ebouchut Oct 22, 2024
74de909
Fix PR #84: ✏️ Fix Typo in Max Daily Safety Multiplier
ebouchut Oct 22, 2024
50c80fb
✏️ Fix typo: Add missing indentation for sub-list items
ebouchut Oct 22, 2024
59ca5f5
🔥 Remove Glucose Direct
ebouchut Oct 23, 2024
c9edded
👷 Add a workflow to prevent blocked PRs from being merged
ebouchut Oct 24, 2024
746adb9
💚 Fix PR Dependencies Check Workflow
ebouchut Oct 27, 2024
bf9b1f4
✏️ Fix typos in the Citations page
ebouchut Oct 27, 2024
0807891
✏️ Fix a typo in the Build page
ebouchut Oct 27, 2024
b2fdbd6
Merge pull request #83 from ebouchut/mkdocs-material-migration
MikePlante1 Oct 29, 2024
7a502f5
💚 Hot Fix CORS error in publish GH action workflow
ebouchut Oct 29, 2024
7d71a62
Merge pull request #89 from ebouchut/fix/ci_disable_pdf_generation
MikePlante1 Oct 29, 2024
6afdfb4
✏️ Fix broken links on the translation page
ebouchut Oct 29, 2024
119c6da
Merge pull request #90 from ebouchut/fix/translation_urls
MikePlante1 Oct 29, 2024
41d09ab
✏️ Fix typo in ordered list (Page build)
ebouchut Oct 30, 2024
cf6279e
Remove iAPS repository link
tmhastings Nov 1, 2024
2f9f5f0
Merge pull request #94 from nightscout/tmhastings-remove-link
MikePlante1 Nov 1, 2024
64864f5
Merge branch 'dev' into fix/remove_glucose_direct
ebouchut Nov 2, 2024
dbb6ad9
✏️ Fix a typo in the Build page
ebouchut Nov 2, 2024
ec0f5a8
⚰️ Remove the last residue of GlucoseDirect
ebouchut Nov 2, 2024
37cdd4f
Merge pull request #86 from ebouchut/fix/remove_glucose_direct
MikePlante1 Nov 3, 2024
ad9b1c0
Merge pull request #85 from ebouchut/config/pr-dependency-check
MikePlante1 Nov 3, 2024
c6676d1
Add Libre 2+ to list of supported CGMs
tmhastings Nov 11, 2024
dbfe60f
Merge pull request #95 from tmhastings/tmhastings-libre-2+
tmhastings Nov 11, 2024
a422542
Update CGM page
MikePlante1 Nov 11, 2024
3efc6d6
add missing slash
MikePlante1 Nov 12, 2024
082d072
Merge pull request #96 from MikePlante1/cgm-page
MikePlante1 Nov 12, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .github/workflows/pr_dependencies_check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Prevent Blocked PRs from being Merged

on:
pull_request:
types:
- opened
- edited
- closed
- reopened
issues:
types:
- opened
- edited
- deleted
- transferred
- closed
- reopened

jobs:
blocking_issues:
runs-on: ubuntu-latest
steps:
- uses: Levi-Lesches/blocking-issues@v2
66 changes: 66 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
name: publish

# Controls when the action will run.
on:
# Remark: uncomment one section only
# Remark: Next 1 line requires manual action, Click on action tab, then publish
# workflow_dispatch
# Remark: Next 5 lines triggers the workflow on push events for the main branch
push:
branches:
- dev
paths-ignore:
- "README.md"

jobs:
deploy:
runs-on: ubuntu-latest
permissions:
contents: write
if: github.repository_owner == 'nightscout'
steps:
- name: Checkout Repository
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.x

- name: Create, Activate and share a Python Virtual Env
run: |
python -m venv venv
source venv/bin/activate
# Persist venv related variables across the steps below
# See: https://stackoverflow.com/a/74669486/386517
echo "PATH=$PATH" >> "$GITHUB_ENV"
echo "VIRTUAL_ENV=$VIRTUAL_ENV" >> "$GITHUB_ENV"

- name: Install Python Dependencies
run: pip install -r requirements.txt

- name: Get Playwright Version (Headless Browser)
run: |
echo "PLAYWRIGHT_VERSION=$(playwright --version | cut -d ' ' -f 2)" >> $GITHUB_ENV

- name: Cache Playwright Binaries
id: playwright
uses: actions/cache@v4
with:
path: ~/.cache/ms-playwright
key: playwright-${{ env.PLAYWRIGHT_VERSION }}

- name: Install Playwright (if not cached)
if: steps.playwright.outputs.cache-hit != 'true'
run: playwright install --with-deps chromium

- name: Build Website
run: mkdocs build

- name: Push Website to gh-pages Branch
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages
folder: site
20 changes: 20 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# macOS
.DS_Store


# Python Virtual Environment
venv*/

# Mkdocs
target/
/build/
/site/

# JS
node_modules/

# Playwright
/test-results/
/playwright-report/
/blob-report/
/playwright/.cache/
Loading