Related problem
FCP-INDI/C-PAC#2196 is an initial pass at adding continuous integration functionality for C-PAC documentation. The nodeblock_index.json file is populated with updated nodeblock documentation, which will then be read into https://fcp-indi.github.io/cpac-docs.
Proposed feature
CI functionality for nodeblocks in C-PAC docs
Acceptance criteria
address the following comments:
I think all this functionality is just in service of the documentation CI, not anything happening in C-PAC itself. In that case, I think we should move the scripts from scripts to .github/scripts and add
.github/scripts/config_extractor.py
.github/scripts/nodeblock_docs.py
to .dockerignore after https://github.com/childmindresearch/C-PAC-test/blob/9c876c3a29a0ca97d4acfa7d6cfbd037f5ba9e44/.dockerignore#L7
OR these scripts and most of the workflow could live in https://github.com/FCP-INDI/cpac-docs and this repo could just add a workflow that triggers the workflow over there.
Not at all a blocker for merging this, but I think this would be easier to follow and maintain with more thorough type hints.
There's some wheel reinventing here that I'm not sure is necessary (but it might be? I'm also not sure it isn't necessary). I commented some suggestions, that, if accepted, I think several of the functions here could then be removed entirely.
Alternatives
No response
Additional context
No response
Related problem
FCP-INDI/C-PAC#2196 is an initial pass at adding continuous integration functionality for C-PAC documentation. The nodeblock_index.json file is populated with updated nodeblock documentation, which will then be read into https://fcp-indi.github.io/cpac-docs.
Proposed feature
CI functionality for nodeblocks in C-PAC docs
Acceptance criteria
address the following comments:
I think all this functionality is just in service of the documentation CI, not anything happening in C-PAC itself. In that case, I think we should move the scripts from
scriptsto.github/scriptsand addto
.dockerignoreafter https://github.com/childmindresearch/C-PAC-test/blob/9c876c3a29a0ca97d4acfa7d6cfbd037f5ba9e44/.dockerignore#L7OR these scripts and most of the workflow could live in https://github.com/FCP-INDI/cpac-docs and this repo could just add a workflow that triggers the workflow over there.
Not at all a blocker for merging this, but I think this would be easier to follow and maintain with more thorough type hints.
There's some wheel reinventing here that I'm not sure is necessary (but it might be? I'm also not sure it isn't necessary). I commented some suggestions, that, if accepted, I think several of the functions here could then be removed entirely.
Alternatives
No response
Additional context
No response