Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,18 @@ jobs:
if: "!contains(github.event.pull_request.labels.*.name, 'docs-only')"
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
python: ['3.9', '3.10', '3.11']
os: [ubuntu-latest]
python: ["3.9", "3.12"]
include:
- os: macos-latest
python: "3.12"
- os: windows-latest
python: "3.12"

steps:
- uses: actions/checkout@v4
- uses: compas-dev/compas-actions.build@v4
with:
python: ${{ matrix.python }}
Expand Down
4 changes: 3 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: compas-dev/compas-actions.docs@v4
- uses: compas-dev/compas-actions.docs@v5
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
generator: mkdocs
extras: dev,mkdocs
2 changes: 1 addition & 1 deletion .github/workflows/pr-checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
name: Check Actions
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: actions/checkout@v4
- name: Changelog check
uses: Zomzog/changelog-checker@v1.2.0
with:
Expand Down
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added

* 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).

### Changed

### Removed
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

ETH Zurich
Copyright (c) 2026 COMPAS Association

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
1 change: 0 additions & 1 deletion docs/_images/PLACEHOLDER

This file was deleted.

Binary file added docs/_logo/compas_logo_white_transparent.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_logo/favicon.ico
Binary file not shown.
1 change: 0 additions & 1 deletion docs/_static/PLACEHOLDER

This file was deleted.

12 changes: 0 additions & 12 deletions docs/api.rst

This file was deleted.

3 changes: 3 additions & 0 deletions docs/api/build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Build Tasks

::: compas_invocations2.build
3 changes: 3 additions & 0 deletions docs/api/console.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Console Tasks

::: compas_invocations2.console
3 changes: 3 additions & 0 deletions docs/api/docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Documentation Tasks

::: compas_invocations2.docs
3 changes: 3 additions & 0 deletions docs/api/style.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Style Tasks

::: compas_invocations2.style
3 changes: 3 additions & 0 deletions docs/api/tests.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Test Tasks

::: compas_invocations2.tests
5 changes: 5 additions & 0 deletions docs/assets/stylesheets/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
:root > * {
--md-primary-fg-color: #0092d2;
--md-primary-fg-color--light: #0092d2;
--md-primary-fg-color--dark: #0092d2;
}
154 changes: 0 additions & 154 deletions docs/conf.py

This file was deleted.

Empty file removed docs/examples/PLACEHOLDER
Empty file.
10 changes: 10 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# COMPAS Invocations 2

A collection of reusable [`pyinvoke`](https://pyinvoke.org/) tasks for COMPAS packages.

## Features

- **Project Management**: Tasks for releasing, cleaning, and managing changelogs.
- **Documentation**: Tasks for building Sphinx and MkDocs documentation.
- **Code Style**: Tasks for linting (ruff) and formatting (black/isort).
- **Testing**: Tasks for running pytest and doctests.
31 changes: 0 additions & 31 deletions docs/index.rst

This file was deleted.

7 changes: 7 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Installation

Install `compas_invocations2` using `pip` from the Python Package Index.

```bash
pip install compas_invocations2
```
9 changes: 0 additions & 9 deletions docs/installation.rst

This file was deleted.

3 changes: 3 additions & 0 deletions docs/license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# License

--8<-- "LICENSE"
5 changes: 0 additions & 5 deletions docs/license.rst

This file was deleted.

Loading
Loading