Python: api doc generation setup (#342)

* api doc generation setup

* remove old log file

* improved check md function

* update with sample code in docstring

* updated script

* docs update

* docs update and action

* removed all-extras

* fixed sync command

* moved install

* moved action

* renamed folder

* fixed syntax

* add python path

* fix mypy and reused steps

* updated merge test

* undo change

* slight update in poe commands

* dev setup update

* updated uvlock
This commit is contained in:
Eduard van Valkenburg
2025-09-16 12:02:53 +02:00
committed by GitHub
Unverified
parent 66fe1c957c
commit 65dd48aa1d
58 changed files with 676 additions and 2588 deletions
+27 -9
View File
@@ -550,6 +550,12 @@ uv run poe test
### Documentation
#### `docs-install`
Install including the documentation tools:
```bash
uv run poe docs-install
```
#### `docs-clean`
Remove the docs build directory:
```bash
@@ -562,22 +568,34 @@ Build the documentation:
uv run poe docs-build
```
#### `docs-serve`
Serve documentation locally with auto-reload:
#### `docs-full`
Build the packages, clean and build the documentation:
```bash
uv run poe docs-serve
uv run poe docs-full
```
#### `docs-check`
Build documentation and fail on warnings:
#### `docs-rebuild`
Clean and build the documentation:
```bash
uv run poe docs-check
uv run poe docs-rebuild
```
#### `docs-check-examples`
Check documentation examples for code correctness:
#### `docs-full-install`
Install the docs dependencies, build the packages, clean and build the documentation:
```bash
uv run poe docs-check-examples
uv run poe docs-full-install
```
#### `docs-debug`
Build the documentation with debug information:
```bash
uv run poe docs-debug
```
#### `docs-rebuild-debug`
Clean and build the documentation with debug information:
```bash
uv run poe docs-rebuild-debug
```
### Code Validation