search

hdmf-dev / hdmf-docutils

Collection of CLIs, scripts and modules useful to generate HDMF/NWB schema documentation
Other
0 stars 3 forks source link

Setup GitHub test pipelines #78

Closed oruebel closed 10 months ago

oruebel commented 2 years ago

As part of PRs we should run the following test pipelines:

1) Build the NWB schema docs to ensure changes are not affecting the docs 2) Build hdmf-common-schema docs

mavaylon1 commented 1 year ago

@oruebel When we build readthedoc on PRs, that is usually from the corresponding repository and the readthedoc advanced settings. You want that build "preview" of whether it passed on each update on a PR for nwb-schema and hdmf-common-schema docs here as well? Correct?

oruebel commented 1 year ago

You want that build "preview" of whether it passed on each update on a PR for nwb-schema and hdmf-common-schema docs here as well? Correct?

I'm not sure running this on readthedocs will work in this case, because this is a different repo and because the wb-schema and hdmf-common-schema docs are installing the hdmf-docutils from PIP. I think it may be easiest to have a GitHub action workflow to build the docs for these repos using the hdmf-docutils from the corresponding PR.