docs: auto update dev docs & minify files

aphp · Sep 15, 2023 · f8530c6 · f8530c6
1 parent b67fcce
commit f8530c6
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 4 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -2,7 +2,10 @@ name: Documentation
 
 on:
   push:
-    branches: [master]
+    branches: [master, dev]
+
+env:
+  BRANCH_NAME: ${{ github.head_ref || github.ref_name }}
 
 jobs:
   Documentation:
@@ -21,5 +24,5 @@ jobs:
     - name: Build documentation
       run: |
         git fetch origin gh-pages
-        mike delete master
-        mike deploy --push master
+        mike delete $BRANCH_NAME
+        mike deploy --push $BRANCH_NAME
diff --git a/docs/index.md b/docs/index.md
@@ -1,4 +1,4 @@
-# Getting started
+# Getting started okokok
 
 EDS-NLP provides a set of spaCy components that are used to extract information from clinical notes written in French.
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -170,6 +170,13 @@ hooks:
 
 plugins:
   - search
+  - minify:
+      minify_html: true
+      minify_js: true
+      minify_css: true
+      htmlmin_opts:
+          remove_comments: true
+      cache_safe: true
   - autorefs:
       priority:
         - .*

diff --git a/pyproject.toml b/pyproject.toml
@@ -51,6 +51,7 @@ dev = [
     "mkdocs~=1.5.2",
     "mkdocstrings~=0.20",
     "mkdocstrings-python~=1.1",
+    "mkdocs-minify-plugin",
     "pybtex~=0.24.0",
     "pathspec>=0.11.1",  # required by vendored mkdocs-autorefs PR
     "astunparse",