Skip to content

Commit 3be1cc8

Browse files
authored
Merge pull request #496 from kissgyorgy/docs
Fix documentation deployment
2 parents f9aa92f + ca6df64 commit 3be1cc8

File tree

4 files changed

+43
-9
lines changed

4 files changed

+43
-9
lines changed

.github/workflows/documentation.yml

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,38 @@ jobs:
1818
with:
1919
python-version: 3.8
2020

21-
- name: Restore pipx cache
21+
- name: Setup Python
22+
uses: actions/setup-python@v2
23+
with:
24+
python-version: 3.8
25+
26+
- name: Restore pip cache
2227
uses: actions/cache@v2
2328
with:
24-
path: ~/.local/pipx
25-
key: pipx-cache
29+
path: ~/.cache/pip
30+
key: pip-3.8
31+
32+
- name: Upgrade pip and install poetry
33+
run: python -m pip install --upgrade pip poetry
34+
shell: bash
35+
36+
- name: Restore poetry cache
37+
uses: actions/cache@v2
38+
with:
39+
path: |
40+
~/.cache/pypoetry/cache
41+
~/.cache/pypoetry/artifacts
42+
key: poetry-cache-and-artifacts-3.8
43+
44+
- name: Restore virtualenvs
45+
uses: actions/cache@v2
46+
with:
47+
path: ~/.cache/pypoetry/virtualenvs
48+
key: venv-${{ hashFiles('poetry.lock') }}-3.8
49+
50+
- name: Poetry install
51+
run: poetry install --only docs
52+
shell: bash
2653

27-
- run: pipx run --spec "mkdocs-material==8.5.10" mkdocs gh-deploy --force
54+
- name: Generate documentation
55+
run: poetry run mkdocs gh-deploy --force

docs/extra.css

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
src: url("ArtegraSans-Regular.ttf");
44
}
55

6-
html {
7-
font-family: "Artegra Sans", Sans-serif;
6+
:root {
7+
--md-text-font: "Artegra Sans";
88
}
99

1010
[data-md-color-scheme="default"] {

mkdocs.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,7 @@ theme:
3535
name: material
3636
logo: logo.svg
3737
favicon: favicon.png
38-
font:
39-
text: Artegra Sans
38+
font: false
4039
palette:
4140
- media: "(prefers-color-scheme: light)"
4241
scheme: default

pyproject.toml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,20 @@ lark = "^1.1.2"
3131
lz4 = "^4.0.0"
3232
lief = "^0.12.3"
3333

34+
[tool.poetry.group.dev]
35+
optional = true
3436

35-
[tool.poetry.dev-dependencies]
37+
[tool.poetry.group.dev.dependencies]
3638
pytest = "^6.2.4"
3739
pyright = "^0.0.12"
3840
pre-commit = "^2.15.0"
3941
pytest-cov = "^3.0.0"
4042
setuptools-rust = "^1.1.2"
43+
44+
[tool.poetry.group.docs]
45+
optional = true
46+
47+
[tool.poetry.group.docs.dependencies]
4148
mkdocs-material = "8.5.10"
4249
mkdocstrings = "^0.19.1"
4350
pillow = "^9.4.0"

0 commit comments

Comments
 (0)