Repository navigation
fix(doc): point doxygen INPUT at the fetched stela and indep sources - #63
Conversation
The clog, indep, meta, memlite and stela modules moved out of this repository, but DoxyReference-ko/-en kept listing them under ../module, so the reference build silently produced no API pages for any of them and every @ref by::stela link in the architecture documents dangled. FetchContent puts them under the build directory, so point INPUT there instead. The paths are relative to build/, matching the existing doxygen and ../doc/ref entries. Run a build before builder.py doc so _deps is populated. Claude-Session: https://claude.ai/code/session_01SYqFWgKvvCf4untQ9sGvDQ
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: fb928b3b09
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| _deps/indep_dep-src/module/indep \ | ||
| _deps/stela_dep-src/module/clog \ | ||
| _deps/stela_dep-src/module/meta \ | ||
| _deps/stela_dep-src/module/memlite \ | ||
| _deps/stela_dep-src/module/stela \ |
There was a problem hiding this comment.
Populate fetched sources before generating reference docs
The production publish-doc job checks out a clean tree and then runs only builder.py doc (.github/workflows/ci-main.yml lines 584-585 and 633-639). That command invokes Doxygen without configuring CMake (build/builder.py lines 227-237), while these _deps directories are created only by FetchContent_MakeAvailable(stela_dep) during CMake configuration (module/core/CMakeLists.txt lines 8-13). Consequently both newly added input directories are absent on every documentation-publishing run, so Doxygen continues to omit the stela/indep API pages this change is intended to restore. Make the doc workflow/command populate the dependencies first, or fetch them independently before Doxygen runs.
Useful? React with 👍 / 👎.
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
The reference INPUT points at _deps/{stela,indep}_dep-src, which only CMake FetchContent creates at configure time. doc ran doxygen without configuring, so the clean publish-doc runner had neither directory and the stela/indep API pages stayed empty despite #63's path fix. doc() now configures once (skipping when _deps already exists) so the fetched sources are present.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
문제
build/DoxyReference-ko/-en의INPUT이 아직도 아래 경로들을 가리키고 있습니다.이 다섯 모듈은 stela / indep 저장소로 분리되어 나갔기 때문에 이 저장소에는 존재하지 않습니다. 현재
byeol/module/에 남아 있는 것은core,frontend,bundle,test뿐입니다.Doxygen은 없는
INPUT디렉토리를 경고만 내고 넘어가므로, 그동안 레퍼런스 사이트가 조용히 다음 상태로 빌드되고 있었습니다.aj-architecture-stela.md를 비롯한 아키텍처 문서의@ref by::stela,@ref by::valStela,@ref by::stelaParser링크가 전부 dangling수정
FetchContent가 받아오는 실제 위치로INPUT을 돌렸습니다._deps/stela_dep-src/module/{clog,meta,memlite,stela}_deps/indep_dep-src/module/indep(indep은 stela에서 다시 분리되어 별도 저장소이므로 base dir이 다릅니다)경로는 기존
doxygen,../doc/ref/ko항목과 동일하게build/기준 상대경로입니다. 나열 순서는 아키텍처 문서의 계층 순서(indep → clog → meta → memlite → stela → core → frontend)에 맞췄습니다.검증
_deps를 채운 뒤DoxyReference-ko를 실제로 돌려 확인했습니다.by::클래스 페이지 705개 생성 (수정 전에는 core/frontend 분량만)arrStela,defStela,strStela,valStela,verStela,nulStela,stelaParser,stelaWriter,stelaVisitInfo페이지 생성 확인aj-architecture-stela.html의@ref by::stela가classby_1_1stela.html로 정상 링크됨남은 것 (이 PR 범위 밖)
builder.py doc은 빌드를 하지 않으므로_deps가 비어 있으면 여전히 API 페이지가 비어 나옵니다. 문서 생성 전에 빌드가 선행되어야 하고, 이를doc()이 보장하도록 할지는 별도 판단이 필요해 보입니다.stelaVisitor와 core의visitor는 클래스 본문 안에서visitee.inl을#include하는 X-macro 패턴 때문에 Doxygen이 클래스로 잡지 못합니다. 이 PR 이전부터 있던 문제이고 stela 전용도 아니라 손대지 않았습니다.EXCLUDE = ../mods/unittest도 존재하지 않는 경로입니다. 무해해서 그대로 뒀습니다.https://claude.ai/code/session_01SYqFWgKvvCf4untQ9sGvDQ