Description
Set up Sphinx autodoc to generate API reference documentation from docstrings.
Tasks
- Create
docs/ directory with Sphinx configuration
- Add
docs/conf.py with autodoc, napoleon (Google-style docstrings), and intersphinx
- Create
docs/api/ with one .rst file per module
- Add
docs/Makefile for building HTML docs
- Add GitHub Actions job to build docs on PR and deploy to GitHub Pages on merge
Modules to document
landmarkdiff.landmarks — face detection and landmark extraction
landmarkdiff.manipulation — procedure-specific deformation
landmarkdiff.conditioning — ControlNet conditioning generation
landmarkdiff.evaluation — metrics computation
landmarkdiff.api_client — REST API client
landmarkdiff.synthetic — training pair generation
Acceptance criteria
Description
Set up Sphinx autodoc to generate API reference documentation from docstrings.
Tasks
docs/directory with Sphinx configurationdocs/conf.pywith autodoc, napoleon (Google-style docstrings), and intersphinxdocs/api/with one.rstfile per moduledocs/Makefilefor building HTML docsModules to document
landmarkdiff.landmarks— face detection and landmark extractionlandmarkdiff.manipulation— procedure-specific deformationlandmarkdiff.conditioning— ControlNet conditioning generationlandmarkdiff.evaluation— metrics computationlandmarkdiff.api_client— REST API clientlandmarkdiff.synthetic— training pair generationAcceptance criteria
docs/conf.pyconfigured with autodoc + napoleonmake htmlbuilds without warnings