Skip to content

Commit f8530c6

Browse files
committed
docs: auto update dev docs & minify files
1 parent b67fcce commit f8530c6

File tree

4 files changed

+15
-4
lines changed

4 files changed

+15
-4
lines changed

.github/workflows/documentation.yml

+6-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@ name: Documentation
22

33
on:
44
push:
5-
branches: [master]
5+
branches: [master, dev]
6+
7+
env:
8+
BRANCH_NAME: ${{ github.head_ref || github.ref_name }}
69

710
jobs:
811
Documentation:
@@ -21,5 +24,5 @@ jobs:
2124
- name: Build documentation
2225
run: |
2326
git fetch origin gh-pages
24-
mike delete master
25-
mike deploy --push master
27+
mike delete $BRANCH_NAME
28+
mike deploy --push $BRANCH_NAME

docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Getting started
1+
# Getting started okokok
22

33
EDS-NLP provides a set of spaCy components that are used to extract information from clinical notes written in French.
44

mkdocs.yml

+7
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,13 @@ hooks:
170170

171171
plugins:
172172
- search
173+
- minify:
174+
minify_html: true
175+
minify_js: true
176+
minify_css: true
177+
htmlmin_opts:
178+
remove_comments: true
179+
cache_safe: true
173180
- autorefs:
174181
priority:
175182
- .*

pyproject.toml

+1
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ dev = [
5151
"mkdocs~=1.5.2",
5252
"mkdocstrings~=0.20",
5353
"mkdocstrings-python~=1.1",
54+
"mkdocs-minify-plugin",
5455
"pybtex~=0.24.0",
5556
"pathspec>=0.11.1", # required by vendored mkdocs-autorefs PR
5657
"astunparse",

0 commit comments

Comments
 (0)