search

christiansandberg / canopen

CANopen for Python
http://canopen.readthedocs.io/
MIT License
437 stars 194 forks source link

CI: Build docs in CI #498

Closed erlend-aasland closed 2 months ago

erlend-aasland commented 2 months ago

Resolves #497

acolomb commented 2 months ago

Our "CI" for the docs actually lives on readthedocs.org, as each commit on master is built there under the latest version. Testing here may actually lead to less PRs getting merged that break the online docs, so that's positive.

This doesn't make an effort though to separate action runs between docs-only and code-only changes, as mentioned in #497? Since any code change also affects the docs, and docs-only fixes are rare, I can live with that.

erlend-aasland commented 2 months ago

This doesn't make an effort though to separate action runs between docs-only and code-only changes, as mentioned in https://github.com/christiansandberg/canopen/issues/497? Since any code change also affects the docs, and docs-only fixes are rare, I can live with that.

Yes. I'm not used to the docstrings being so tightly coupled with the rendered docs; I simply forgot that it's not possible to do that separation with the current setup.

acolomb commented 2 months ago

I just hope Someone(TM) will be there to bump these versioned dependencies when they have bit-rotted enough ;-)

Let's try what happens with this action.

acolomb commented 2 months ago

So it seems there are no artifacts? Wouldn't it make sense to build some kind of HTML bundle while we're already generating the docs?

erlend-aasland commented 2 months ago

So it seems there are no artifacts? Wouldn't it make sense to build some kind of HTML bundle while we're already generating the docs?

That's a very good idea.