From 02914396bb930614d39059198986221aef6dbed8 Mon Sep 17 00:00:00 2001 From: marionbarker Date: Sun, 11 May 2025 09:31:13 -0700 Subject: [PATCH 001/183] update requirements and README --- README.md | 5 ++-- dev-requirements.in | 1 + dev-requirements.txt | 24 ++++++++++++++++++ requirements.in | 16 ++++++------ requirements.txt | 60 +++++++++++++++++++++++++++++++++++++------- 5 files changed, 88 insertions(+), 18 deletions(-) create mode 100644 dev-requirements.in create mode 100644 dev-requirements.txt diff --git a/README.md b/README.md index fe1ce23baef..b4571670e0a 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ This repository contains the source files for [Loop's](https://github.com/LoopKi - [**Requirements**](https://loopkit.github.io/loopdocs/intro/requirements/) - [Build Loop](https://loopkit.github.io/loopdocs/intro/requirements/#two-loop-build-methods) - [Configuration](https://loopkit.github.io/loopdocs/loop-3/loop-3-overview/) -- [Usage](https://loopkit.github.io/loopdocs/operation/loop/open-loop/) +- [Usage](https://loopkit.github.io/loopdocs/operation/loop/close-loop/) - [Troubleshooting](https://loopkit.github.io/loopdocs/troubleshooting/overview/) - Remote monitoring and commands with [*Nightscout*](https://loopkit.github.io/loopdocs/nightscout/overview/) - [FAQs](https://loopkit.github.io/loopdocs/faqs/overview-faqs/) @@ -52,7 +52,8 @@ If it is a more substantive change and you want to [install LoopDocs locally](#i ```shell cd loopdocs # Make sure you are in the folder where you cloned this repository - python -m pip install -r requirements.txt + python -m pip install -r dev-requirements.txt + python -m pip install -r requirements.txt ``` ## Run diff --git a/dev-requirements.in b/dev-requirements.in new file mode 100644 index 00000000000..2c2a9f38416 --- /dev/null +++ b/dev-requirements.in @@ -0,0 +1 @@ +pip-tools diff --git a/dev-requirements.txt b/dev-requirements.txt new file mode 100644 index 00000000000..76bfa83bbe6 --- /dev/null +++ b/dev-requirements.txt @@ -0,0 +1,24 @@ +# +# This file is autogenerated by pip-compile with Python 3.12 +# by the following command: +# +# pip-compile --output-file=dev-requirements.txt dev-requirements.in +# +build==1.2.2.post1 + # via pip-tools +click==8.1.7 + # via pip-tools +packaging==24.1 + # via build +pip-tools==7.4.1 + # via -r dev-requirements.in +pyproject-hooks==1.2.0 + # via + # build + # pip-tools +wheel==0.44.0 + # via pip-tools + +# The following packages are considered to be unsafe in a requirements file: +# pip +# setuptools diff --git a/requirements.in b/requirements.in index c3eeb4a5b80..8e895da9cce 100644 --- a/requirements.in +++ b/requirements.in @@ -1,7 +1,9 @@ -Jinja2==3.1.6 -mkdocs==1.6.1 -mkdocs-htmlproofer-plugin==1.3.0 -mkdocs-material==9.6.7 -mkdocs-redirects==1.2.2 -mkdocs-unused-files==0.2.0 -pymdown-extensions==10.14.3 +jinja2~=3.1 +mkdocs~=1.6.1 +mkdocs-exporter~=6.2 +mkdocs-material~=9.6 +mkdocs-htmlproofer-plugin~=1.3 +mkdocs-include-markdown-plugin~=7.1.5 +mkdocs-open-in-new-tab~=1.0 +mkdocs-macros-plugin~=1.3 +mkdocs-unused-files~=0.2 diff --git a/requirements.txt b/requirements.txt index 3740a5fab80..b6321af0149 100644 --- a/requirements.txt +++ b/requirements.txt @@ -10,8 +10,11 @@ backrefs==5.8 # via mkdocs-material beautifulsoup4==4.13.3 # via + # mkdocs-exporter # mkdocs-htmlproofer-plugin # mkdocs-unused-files +bracex==2.5.post1 + # via wcmatch certifi==2025.1.31 # via requests charset-normalizer==3.4.1 @@ -22,13 +25,24 @@ colorama==0.4.6 # via mkdocs-material ghp-import==2.1.0 # via mkdocs +greenlet==3.1.1 + # via playwright +hjson==3.1.0 + # via + # mkdocs-macros-plugin + # super-collections idna==3.10 # via requests jinja2==3.1.6 # via # -r requirements.in # mkdocs + # mkdocs-macros-plugin # mkdocs-material +libsass==0.23.0 + # via mkdocs-exporter +lxml==5.3.1 + # via mkdocs-exporter markdown==3.7 # via # mkdocs @@ -46,42 +60,62 @@ mergedeep==1.3.4 mkdocs==1.6.1 # via # -r requirements.in + # mkdocs-exporter # mkdocs-htmlproofer-plugin + # mkdocs-include-markdown-plugin + # mkdocs-macros-plugin # mkdocs-material - # mkdocs-redirects + # mkdocs-open-in-new-tab # mkdocs-unused-files +mkdocs-exporter==6.2.0 + # via -r requirements.in mkdocs-get-deps==0.2.0 # via mkdocs mkdocs-htmlproofer-plugin==1.3.0 # via -r requirements.in +mkdocs-include-markdown-plugin==7.1.5 + # via -r requirements.in +mkdocs-macros-plugin==1.3.7 + # via -r requirements.in mkdocs-material==9.6.7 # via -r requirements.in mkdocs-material-extensions==1.3.1 # via mkdocs-material -mkdocs-redirects==1.2.2 +mkdocs-open-in-new-tab==1.0.8 # via -r requirements.in mkdocs-unused-files==0.2.0 # via -r requirements.in packaging==24.2 - # via mkdocs + # via + # mkdocs + # mkdocs-macros-plugin paginate==0.5.7 # via mkdocs-material pathspec==0.12.1 - # via mkdocs + # via + # mkdocs + # mkdocs-macros-plugin platformdirs==4.3.6 # via mkdocs-get-deps +playwright==1.50.0 + # via mkdocs-exporter +pyee==12.1.1 + # via playwright pygments==2.19.1 # via mkdocs-material pymdown-extensions==10.14.3 - # via - # -r requirements.in - # mkdocs-material + # via mkdocs-material +pypdf==5.3.1 + # via mkdocs-exporter python-dateutil==2.9.0.post0 - # via ghp-import + # via + # ghp-import + # mkdocs-macros-plugin pyyaml==6.0.2 # via # mkdocs # mkdocs-get-deps + # mkdocs-macros-plugin # pymdown-extensions # pyyaml-env-tag pyyaml-env-tag==0.1 @@ -94,9 +128,17 @@ six==1.17.0 # via python-dateutil soupsieve==2.6 # via beautifulsoup4 +super-collections==0.5.3 + # via mkdocs-macros-plugin +termcolor==2.5.0 + # via mkdocs-macros-plugin typing-extensions==4.12.2 - # via beautifulsoup4 + # via + # beautifulsoup4 + # pyee urllib3==2.3.0 # via requests watchdog==6.0.0 # via mkdocs +wcmatch==10.0 + # via mkdocs-include-markdown-plugin From 72dd463392280c7d4b408df4a42cd83a97055a02 Mon Sep 17 00:00:00 2001 From: marionbarker Date: Sun, 11 May 2025 09:43:56 -0700 Subject: [PATCH 002/183] configure so external links alwasy have up-right arrow and open in a new tab --- docs/stylesheets/extra.css | 12 ++++++++++++ mkdocs.yml | 1 + 2 files changed, 13 insertions(+) diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index f549b8a0df6..6002c154082 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -1,3 +1,15 @@ +/* + * Materialize links that open in a new window/tab with a right-up arrow icon + */ + .md-main a[target="_blank"]::after, + .document a[target="_blank"]::after { + content: "↗"; + display: inline-block; + margin-left: 0.2em; + width: 1em; + height: 1em; + } + /* Custom styles to override MkDocs defaults and enhance theme */ /* Unordered list