Skip to content

Commit d4b9bc6

Browse files
committed
Update CI-Workflow-Update, Requirements und MkDocs-Sync
This pull request updates the CI workflow configuration, refreshes the `requirements.txt` file with potentially new or updated dependencies, and synchronizes the `mkdocs.yml` configuration files across different language versions (likely `de` and `en`) to ensure consistency in the documentation build process.
1 parent e2dd14c commit d4b9bc6

5 files changed

Lines changed: 63 additions & 44 deletions

File tree

.github/workflows/main.yml

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,37 +3,41 @@ name: CI
33
on:
44
push:
55
branches:
6-
- master
6+
- master
7+
pull_request:
8+
branches:
9+
- master
10+
types: [opened, synchronize, reopened]
711

812
jobs:
9-
build-deploy:
13+
build-and-deploy-documentation:
1014
runs-on: ubuntu-latest
1115
steps:
12-
- uses: actions/checkout@v3
16+
- uses: actions/checkout@v4
1317
with:
1418
fetch-depth: 0
1519
- name: Set up Python
16-
uses: actions/setup-python@v4
20+
uses: actions/setup-python@v5
1721
with:
1822
python-version: 3.11
19-
- name: Caching dependencies
23+
- name: Cache Python dependencies
2024
uses: actions/cache@v3
2125
with:
2226
key: ${{ github.ref }}
2327
path: .cache
24-
- name: Install dependencies
28+
- name: Install Python dependencies
2529
run: |
2630
python -m pip install --upgrade pip
2731
pip install -r requirements.txt
28-
- name: Build English
32+
- name: Build English Documentation
2933
run: mkdocs build -f config/en/mkdocs.yml
30-
- name: Build German
34+
- name: Build German Documentation
3135
run: mkdocs build -f config/de/mkdocs.yml
3236
- name: Copy common root files (including legacy redirects)
3337
run: cp -R docs/root/* site
34-
- name: Deploy
38+
- name: Deploy to GitHub Pages
39+
if: github.ref == 'refs/heads/master' && success()
3540
uses: peaceiris/actions-gh-pages@v3
36-
if: success()
3741
with:
3842
github_token: ${{ secrets.GITHUB_TOKEN }}
3943
publish_dir: ./site

.project

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<projectDescription>
3+
<name>portfolio-help</name>
4+
<comment></comment>
5+
<projects>
6+
</projects>
7+
<buildSpec>
8+
</buildSpec>
9+
<natures>
10+
</natures>
11+
</projectDescription>

config/de/mkdocs.yml

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -16,41 +16,41 @@ edit_uri: 'tree/master/docs/de'
1616
copyright: 'Dieses Werk ist lizenziert unter <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">CC BY-NC-SA 4.0</a>.'
1717

1818
theme:
19-
name: 'material'
19+
name: material
2020
custom_dir: '../../overrides/'
2121
palette:
2222
# Palette toggle for light mode
2323
- scheme: default
2424
toggle:
25-
icon: material/weather-night
26-
name: Switch to dark mode
25+
icon: material/weather-night
26+
name: 'Switch to dark mode'
2727
# Palette toggle for dark mode
2828
- scheme: slate
2929
toggle:
3030
icon: material/weather-sunny
31-
name: Switch to light mode
31+
name: 'Switch to light mode'
3232
features:
33-
- content.code.annotate
33+
- content.code.annotate
3434
- content.code.copy
3535
- navigation.expand
3636
- navigation.indexes
3737
- navigation.tabs
3838
- content.action.edit
39-
logo: 'assets/images/logo.svg'
40-
favicon: 'assets/images/favicon.png'
41-
language: 'de'
39+
logo: assets/images/logo.svg
40+
favicon: assets/images/favicon.png
41+
language: de
4242

4343
extra_css:
4444
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css
4545
- assets/stylesheets/extra.css
4646

4747
extra_javascript:
48-
- assets/javascripts/katex.js
49-
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
48+
- assets/javascripts/katex.js
49+
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
5050
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js
5151

5252
extra:
53-
alternate:
53+
alternate:
5454
- name: English
5555
link: /en/
5656
lang: en
@@ -59,15 +59,15 @@ extra:
5959
lang: de
6060

6161
social:
62-
- icon: 'material/home'
62+
- icon: material/home
6363
link: 'https://www.portfolio-performance.info'
64-
- icon: 'fontawesome/brands/github'
64+
- icon: fontawesome/brands/github
6565
link: 'https://github.com/portfolio-performance/portfolio'
66-
- icon: 'fontawesome/brands/twitter'
66+
- icon: fontawesome/brands/twitter
6767
link: 'https://twitter.com/portfolioperf'
68-
- icon: 'fontawesome/solid/comments'
68+
- icon: fontawesome/solid/comments
6969
link: 'https://forum.portfolio-performance.info'
70-
- icon: 'material/bug'
70+
- icon: material/bug
7171
link: 'https://github.com/portfolio-performance/portfolio/issues'
7272

7373
plugins:
@@ -83,7 +83,7 @@ plugins:
8383
- git-revision-date-localized:
8484
type: date
8585
custom_format: "%d. %B %Y"
86-
timezone: Europe/Amsterdam
86+
timezone: Europe/Berlin
8787
locale: de
8888

8989
markdown_extensions:
@@ -99,13 +99,12 @@ markdown_extensions:
9999
- attr_list
100100
- md_in_html
101101
- tables
102-
102+
103103
nav:
104-
- Einleitung:
104+
- Einleitung:
105105
- Einleitung: index.md
106106
- Erste Schritte:
107107
- Erste Schritte: erste-schritte/index.md
108-
- Installation: erste-schritte/installation.md
109108
- Portfoliodatei anlegen: erste-schritte/intro-neue-portfoliodatei-anlegen.md
110109
- Wertpapiere anlegen: erste-schritte/intro-wertpapiere-anlegen.md
111110
- Bestände aufbauen: erste-schritte/intro-bestaende-erstmalig-aufbauen.md
@@ -155,7 +154,7 @@ nav:
155154
- Sparpläne: referenzhandbuch/ansichten/stammdaten/sparplaene.md
156155
- Alle Transaktionen: referenzhandbuch/ansichten/stammdaten/alle-transaktionen.md
157156
- Berichte:
158-
- Vermögensaufstellung:
157+
- Vermögensaufstellung:
159158
- Vermögensaufstellung: referenzhandbuch/ansichten/berichte/vermoegensaufstellung/index.md
160159
- Vermögensaufstellung Diagramm: referenzhandbuch/ansichten/berichte/vermoegensaufstellung/vermoegensaufstellung-diagramm.md
161160
- Bestand: referenzhandbuch/ansichten/berichte/vermoegensaufstellung/bestand.md
@@ -169,7 +168,7 @@ nav:
169168
- Allgemeine Daten:
170169
- Einstellungen: referenzhandbuch/allgemeine-daten/einstellungen.md
171170
- Währungen: referenzhandbuch/allgemeine-daten/waehrungen.md
172-
- Transaktionsmenü:
171+
- Transaktionsmenü:
173172
- Transaktionen: referenzhandbuch/transaktionen/index.md
174173
- Kauf & Verkauf: referenzhandbuch/transaktionen/kauf-verkauf.md
175174
- Ein- & Auslieferung: referenzhandbuch/transaktionen/ein-auslieferung.md

config/en/mkdocs.yml

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ repo_name: portfolio-performance/portfolio-help
1313
repo_url: https://github.com/portfolio-performance/portfolio-help
1414
edit_uri: tree/master/docs/en/
1515

16-
copyright: This work is licensed under <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">CC BY-NC-SA 4.0</a>.
16+
copyright: 'This work is licensed under <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">CC BY-NC-SA 4.0</a>.'
1717

1818
theme:
1919
name: material
@@ -30,7 +30,7 @@ theme:
3030
icon: material/weather-sunny
3131
name: Switch to light mode
3232
features:
33-
- content.code.annotate
33+
- content.code.annotate
3434
- content.code.copy
3535
- navigation.expand
3636
- navigation.indexes
@@ -45,7 +45,7 @@ extra_css:
4545
- assets/stylesheets/extra.css
4646

4747
extra_javascript:
48-
- assets/javascripts/katex.js
48+
- assets/javascripts/katex.js
4949
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
5050
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js
5151

@@ -80,7 +80,11 @@ plugins:
8080
markdown_identifier: 'Figure:'
8181
table:
8282
position: top
83-
- git-revision-date-localized
83+
- git-revision-date-localized:
84+
type: date
85+
custom_format: "%B %d, %Y"
86+
timezone: Europe/Berlin
87+
locale: en
8488

8589
markdown_extensions:
8690
- admonition
@@ -99,7 +103,7 @@ markdown_extensions:
99103
- tables
100104

101105
nav:
102-
- Introduction:
106+
- Introduction:
103107
- Introduction: index.md
104108
- Getting started:
105109
- Getting started: getting-started/index.md
@@ -109,10 +113,10 @@ nav:
109113
- Managing your portfolio:
110114
- Managing your portfolio: getting-started/manage-portfolio/index.md
111115
- Making a Deposit: getting-started/manage-portfolio/deposit.md
112-
- Buying securities: getting-started/manage-portfolio/buy.md
113-
- Selling securities: getting-started/manage-portfolio/sell.md
116+
- Buying securities: getting-started/manage-portfolio/buy.md
117+
- Selling securities: getting-started/manage-portfolio/sell.md
114118
- Recording a delivery: getting-started/manage-portfolio/delivery.md
115-
- Dividend payment: getting-started/manage-portfolio/dividend.md
119+
- Dividend payment: getting-started/manage-portfolio/dividend.md
116120
- Bonds: getting-started/manage-portfolio/bonds.md
117121
- Measure Performance: getting-started/measure-performance.md
118122
- Classifying assets: getting-started/classify-assets.md

requirements.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
mkdocs == 1.5.3
2-
mkdocs-material == 9.5.9
3-
mkdocs-caption == 1.0.0
4-
mkdocs-git-revision-date-localized-plugin == 1.2.5
1+
mkdocs == 1.6.1
2+
mkdocs-material == 9.6.12
3+
mkdocs-caption == 1.3.0
4+
mkdocs-git-revision-date-localized-plugin == 1.4.5
5+
pymdown-extensions == 10.6

0 commit comments

Comments
 (0)