add separate documentation GA workflow#314
Conversation
sverhoeven
left a comment
sverhoeven
left a comment
There was a problem hiding this comment.
OK for me to have a separate job. Having it in its own workflow file follows the other workflows.
Instead of running the doc build step on a matrix of OSes and Python versions you now only use Ubuntu-latest + Python 3.9.
For the doctests it is helpful to test on the full matrix, as some could behave differently.
Not sure if I ever found bugs in doctests by running them on the full matrix. but this would be a feature that we would loose by merging this PR. I can live without it.
Why did you drop the matrix?
|
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. |
|
Thoughts @sverhoeven? |
sverhoeven
left a comment
sverhoeven
left a comment
There was a problem hiding this comment.
Thanks for explaining.
I am also OK with running doc ci workflow for just the ubuntu/python39.
2 participants
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.