Skip to content

Commit 0e2238a

Browse files
committed
Repo conf manual updates
Signed-off-by: Mathias L. Baumann <[email protected]>
1 parent 044db7e commit 0e2238a

File tree

3 files changed

+19
-5
lines changed

3 files changed

+19
-5
lines changed

.github/workflows/ci.yaml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,10 +88,14 @@ jobs:
8888
# The job name should match the name of the `nox` job.
8989
name: Test with nox
9090
needs: ["nox"]
91+
# We skip this job only if nox was also skipped
92+
if: always() && needs.nox.result != 'skipped'
9193
runs-on: ubuntu-20.04
94+
env:
95+
DEPS_RESULT: ${{ needs.nox.result }}
9296
steps:
93-
- name: Return true
94-
run: "true"
97+
- name: Check matrix job result
98+
run: test "$DEPS_RESULT" = "success"
9599

96100
nox-cross-arch:
97101
name: Cross-arch tests with nox
@@ -202,10 +206,14 @@ jobs:
202206
# The job name should match the name of the `nox-cross-arch` job.
203207
name: Cross-arch tests with nox
204208
needs: ["nox-cross-arch"]
209+
# We skip this job only if nox-cross-arch was also skipped
210+
if: always() && needs.nox-cross-arch.result != 'skipped'
205211
runs-on: ubuntu-20.04
212+
env:
213+
DEPS_RESULT: ${{ needs.nox-cross-arch.result }}
206214
steps:
207-
- name: Return true
208-
run: "true"
215+
- name: Check matrix job result
216+
run: test "$DEPS_RESULT" = "success"
209217

210218
build:
211219
name: Build distribution packages

mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ plugins:
9393
- literate-nav:
9494
nav_file: SUMMARY.md
9595
- mike:
96-
alias_type: redirect
96+
alias_type: symlink
9797
canonical_version: latest
9898
- mkdocstrings:
9999
default_handler: python
@@ -110,6 +110,7 @@ plugins:
110110
show_root_members_full_path: true
111111
show_signature_annotations: true
112112
show_source: true
113+
show_symbol_type_toc: true
113114
signature_crossrefs: true
114115
import:
115116
# See https://mkdocstrings.github.io/python/usage/#import for details

pyproject.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ dev-mkdocs = [
6767
"mkdocs-macros-plugin == 1.0.5",
6868
"mkdocs-material == 9.5.30",
6969
"mkdocstrings[python] == 0.25.2",
70+
"mkdocstrings-python == 1.9.2",
7071
"frequenz-repo-config[lib] == 0.10.0",
7172
]
7273
dev-mypy = [
@@ -148,8 +149,12 @@ disable = [
148149
# pylint's unsubscriptable check is buggy and is not needed because
149150
# it is a type-check, for which we already have mypy.
150151
"unsubscriptable-object",
152+
# Checked by mypy
153+
"no-member",
151154
# Checked by flake8
155+
"f-string-without-interpolation",
152156
"line-too-long",
157+
"missing-function-docstring",
153158
"redefined-outer-name",
154159
"unnecessary-lambda-assignment",
155160
"unused-import",

0 commit comments

Comments
 (0)