NLeSC / python-template

Netherlands eScience Center Python Template
https://research-software-directory.org/software/nlesc-python-template
Apache License 2.0
164 stars 74 forks source link

add separate documentation GA workflow #314

Closed egpbos closed 2 years ago

egpbos commented 2 years ago

Removes building the docs from the build package workflow and adds a separate workflow for this. This way, failing workflow messages are immediately more informative.

egpbos commented 2 years ago

I dropped the matrix to get quicker and cleaner feedback; you don't have to wait in queue as long (quicker) and there is just one checkmark (cleaner). I think it's also pretty easy to add a matrix in for projects where it is needed, but like you I never ran into situations where a build matrix on documentation was necessary, so it is a less wasteful default option. In the end, you're going to have just one main documentation page (on readthedocs) anyway, so in my mind the doc test is mostly just there to see whether the docs compile (on readthedocs) or not.

egpbos commented 2 years ago

Thoughts @sverhoeven?