Ir al contenido

Referencia API

La documentación de referencia del código fuente se genera con pdoc a partir de los docstrings del código Python.

Ventana de terminal
uv sync --group docs
uv run --group docs python scripts/gen_docs.py

Esto genera la documentación en docs/html/.

MóduloDescripción
src/lib/odp_utils/builders/pipeline.pyPipeline principal: build_slides_from_yaml, load_template, save_odp
src/lib/odp_utils/builders/core.pyBuilders de slides: portada, objetivos, índice, texto, bullets
src/lib/odp_utils/builders/content.pyBuilders de contenido: terminal, tabla, imagen, diagrama, aviso
src/lib/odp_utils/builders/code.pyBuilders de código fuente con resaltado de sintaxis
src/lib/slides_config.pyConfiguración de usuario (~/.config/temario/temario.yaml)
src/lib/template_utils.pyLectura de plantillas ODP y template.yaml
src/lib/watcher.pyObserver reactivo para regeneración automática
src/cli/__main__.pyCLI: subcomandos build, clean, version, new, import, validate, watch

El código fuente completo está disponible en el repositorio:

GitLab — pepesan/escriba