Description
Replace the custom docstrings2md.py with proper documentation tooling. mkdocs with mkdocstrings is recommended because:
- Handles Python type annotations correctly
- Generates clean, navigable API docs
- Can output to formats compatible with Docusaurus or replace it
- Active community and good Python support
Alternative Considered
Sphinx with autodoc is also viable but mkdocs has simpler configuration and better markdown support.
Acceptance Criteria
Implementation Notes
Basic mkdocs.yml:
site_name: gcode2dplotterart
theme:
name: material
plugins:
- mkdocstrings:
handlers:
python:
options:
show_source: false
show_signature_annotations: true
nav:
- Home: index.md
- API Reference:
- Plotter2D: api/plotter2d.md
- Plotter3D: api/plotter3d.md
- Layer2D: api/layer2d.md
- Layer3D: api/layer3d.md
Dependencies
Description
Replace the custom
docstrings2md.pywith proper documentation tooling. mkdocs with mkdocstrings is recommended because:Alternative Considered
Sphinx with autodoc is also viable but mkdocs has simpler configuration and better markdown support.
Acceptance Criteria
mkdocs.ymlconfiguration fileImplementation Notes
Basic mkdocs.yml:
Dependencies