32 lines (22 loc) · 726 Bytes

GitHub Pages Configuration for ArchUnitPython Documentation

Documentation Site

URL: https://lukasniessen.github.io/ArchUnitPython/
Source: docs/ folder generated by pdoc
Updates: Automatically on push to main branch

Documentation Generation

Tool: pdoc
Entry Point: src/archunitpython/
Output: docs/ folder
Theme: Default pdoc theme

GitHub Actions

Documentation Deployment: .github/workflows/docs.yaml
Integration Tests: .github/workflows/integrate.yaml

Local Development

# Install pdoc
pip install pdoc

# Generate documentation
pdoc src/archunitpython/ -o docs/

# Serve locally
pdoc src/archunitpython/