AcademySoftwareFoundation / AcademySoftwareFoundation/OpenColorIO

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

オープン
#1,073 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る
Documentation Needs Discussion
主要言語
C++
スター
2.1k
フォーク
503
PR マージ指標
30日以内にマージされた PR はありません

説明

@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`

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

mkdoc.py と analysis_workflow.yml および ci_workflow.yml の依存関係設定から始め、docstring の抽出がどのように呼び出されているかを追跡します。未解決の判断事項は、Python clang package をサポートするのか、それとも抽出方法を変更する必要があるのかです。依存関係または代替案について合意され、CI workflow がそれを再現可能な形で処理できれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
github-actions, python
領域
build-system, ci-cd
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。