AcademySoftwareFoundation / AcademySoftwareFoundation/OpenColorIO

[docs] Docstring Extraction has a Python-side Clang dependency - CI Workflow?

Abierto
#1,073 2 comentarios 0 reacciones 0 asignados Ver en GitHub
Documentation Needs Discussion
Lenguaje dominante
C++
Estrellas
2.1k
Forks
505
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

@michdolan after pushing my branch for a PR (https://github.com/scoopxyz/OpenColorIO/tree/feature/python_docstrings)
I realized that the Python script that extracts the docstrings from the headers and creates the string-literals that get referenced in the PyBind11 bindings requires Python Clang in order to traverse the source headers.

First off, that would make the `Clang` (https://pypi.org/project/clang/) Python package a dependency of the Python bindings. Are we ok with that? If not then we'd have to replicate the `mkdoc.py` behavior without the Clang package. Which I'd definitely ask for help with...

Looking at the CI GitHub workflow, I don't see a place where we control Python dependencies of our CI. I see that the bash scripts are run for the `analysis_workflow.yml` to install things like numpy for this setup, but there is no equivalent step in `ci_workflow.yml`

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza con mkdoc.py y la configuración de dependencias en analysis_workflow.yml y ci_workflow.yml; sigue cómo se invoca la extracción de docstrings. La decisión pendiente es si se admite el paquete Python clang o si debe cambiar el enfoque de extracción. Se considera terminado cuando la dependencia o el reemplazo estén acordados y el flujo de trabajo de CI lo gestione de forma reproducible.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
github-actions, python
Área
build-system, ci-cd
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.