Skip to content

Commit 3718dad

Browse files
authored
Merge pull request #11 from compas-dev/mkdocs
Add mkdocs support
2 parents a2f6353 + 7650103 commit 3718dad

31 files changed

+248
-245
lines changed

.github/workflows/build.yml

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,18 @@ jobs:
1313
if: "!contains(github.event.pull_request.labels.*.name, 'docs-only')"
1414
runs-on: ${{ matrix.os }}
1515
strategy:
16+
fail-fast: false
1617
matrix:
17-
os: [ubuntu-latest, macos-latest, windows-latest]
18-
python: ['3.9', '3.10', '3.11']
18+
os: [ubuntu-latest]
19+
python: ["3.9", "3.12"]
20+
include:
21+
- os: macos-latest
22+
python: "3.12"
23+
- os: windows-latest
24+
python: "3.12"
1925

2026
steps:
27+
- uses: actions/checkout@v4
2128
- uses: compas-dev/compas-actions.build@v4
2229
with:
2330
python: ${{ matrix.python }}

.github/workflows/docs.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ jobs:
1414
docs:
1515
runs-on: ubuntu-latest
1616
steps:
17-
- uses: compas-dev/compas-actions.docs@v4
17+
- uses: compas-dev/compas-actions.docs@v5
1818
with:
1919
github_token: ${{ secrets.GITHUB_TOKEN }}
20+
generator: mkdocs
21+
extras: dev,mkdocs

.github/workflows/pr-checks.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
name: Check Actions
1212
runs-on: ubuntu-latest
1313
steps:
14-
- uses: actions/checkout@v1
14+
- uses: actions/checkout@v4
1515
- name: Changelog check
1616
uses: Zomzog/changelog-checker@v1.2.0
1717
with:

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99

1010
### Added
1111

12+
* Added support for `Mkdocs` documentation generation, using `mkdocs.docs` task. (`Mkdocs` is an optional dependency at the moment, but may become a required dependency in the future).
13+
1214
### Changed
1315

1416
### Removed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
ETH Zurich
3+
Copyright (c) 2026 COMPAS Association
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

docs/_images/PLACEHOLDER

Lines changed: 0 additions & 1 deletion
This file was deleted.
7.67 KB
Loading

docs/_logo/favicon.ico

4.74 KB
Binary file not shown.

docs/_static/PLACEHOLDER

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/api.rst

Lines changed: 0 additions & 12 deletions
This file was deleted.

0 commit comments

Comments
 (0)