Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CI: Build docs in CI #498

Merged
merged 4 commits into from
Jul 9, 2024
Merged

Conversation

erlend-aasland
Copy link
Contributor

Resolves #497

@erlend-aasland erlend-aasland force-pushed the ci/docs branch 2 times, most recently from 96bb243 to 9bcb219 Compare July 7, 2024 20:40
doc/requirements.txt Outdated Show resolved Hide resolved
@acolomb
Copy link
Collaborator

acolomb commented Jul 8, 2024

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
Copy link
Contributor Author

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.

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
Copy link
Collaborator

acolomb commented Jul 9, 2024

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 acolomb merged commit c4560da into christiansandberg:master Jul 9, 2024
2 checks passed
@acolomb
Copy link
Collaborator

acolomb commented Jul 9, 2024

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
Copy link
Contributor Author

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.

@erlend-aasland erlend-aasland deleted the ci/docs branch July 9, 2024 07:02
erlend-aasland added a commit to erlend-aasland/canopen that referenced this pull request Aug 12, 2024
Also:
- bump GitHub checkout action to v4
- bump GitHub setup-python action to v5
- ignore README and LICENSE files
- invoke pip according to best practise

Follow-up of christiansandberg#498
erlend-aasland added a commit to erlend-aasland/canopen that referenced this pull request Aug 12, 2024
Also:
- bump GitHub checkout action to v4
- bump GitHub setup-python action to v5
- ignore README and LICENSE files
- invoke pip according to best practise

Follow-up of christiansandberg#498
acolomb pushed a commit that referenced this pull request Aug 12, 2024
Also:
- bump GitHub checkout action to v4
- bump GitHub setup-python action to v5
- ignore README and LICENSE files
- invoke pip according to best practise

Follow-up of #498
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Test docs build in CI
2 participants