Skip to content

Commit c1b7e4e

Browse files
committed
Migration docs to mkdocs
1 parent a8488ad commit c1b7e4e

15 files changed

Lines changed: 174 additions & 229 deletions

File tree

docs/api.rst

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

docs/api/build.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Build Tasks
2+
3+
::: compas_invocations2.build

docs/api/console.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Console Tasks
2+
3+
::: compas_invocations2.console

docs/api/docs.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Documentation Tasks
2+
3+
::: compas_invocations2.docs

docs/api/style.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Style Tasks
2+
3+
::: compas_invocations2.style

docs/api/tests.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Test Tasks
2+
3+
::: compas_invocations2.tests

docs/conf.py

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

docs/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# COMPAS Invocations 2
2+
3+
A collection of reusable pyinvoke tasks for COMPAS packages.
4+
5+
## Features
6+
7+
- **Project Management**: Tasks for releasing, cleaning, and managing changelogs.
8+
- **Documentation**: Tasks for building Sphinx and MkDocs documentation.
9+
- **Code Style**: Tasks for linting (ruff) and formatting (black/isort).
10+
- **Testing**: Tasks for running pytest and doctests.

docs/index.rst

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

docs/installation.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Installation
2+
3+
Install `compas_invocations2` using `pip` from the Python Package Index.
4+
5+
```bash
6+
pip install compas_invocations2
7+
```

0 commit comments

Comments
 (0)