Skip to content

Add docs.rs CI workflow#442

Draft
simo5 wants to merge 1 commit into
latchset:mainfrom
simo5:docsrs
Draft

Add docs.rs CI workflow#442
simo5 wants to merge 1 commit into
latchset:mainfrom
simo5:docsrs

Conversation

@simo5
Copy link
Copy Markdown
Member

@simo5 simo5 commented Apr 14, 2026

Description

Add a GitHub Actions workflow to automatically build project documentation using cargo docs-rs on pushes and pull requests.

This ensures the documentation builds correctly in an environment similar to docs.rs and uses the nightly toolchain with warnings denied to catch documentation issues early in CI.

Checklist

  • Test suite updated
  • Rustdoc string were added or updated
  • CHANGELOG and/or other documentation added or updated
  • This is not a code change

Reviewer's checklist:

  • Any issues marked for closing are fully addressed
  • There is a test suite reasonably covering new functionality or modifications
  • This feature/change has adequate documentation added
  • A changelog entry is added if the change is significant
  • Code conform to coding style that today cannot yet be enforced via the check style test
  • Commits have short titles and sensible text
  • Doc string are properly updated

Add a GitHub Actions workflow to automatically build project documentation
using cargo docs-rs on pushes and pull requests.

This ensures the documentation builds correctly in an environment similar to
docs.rs and uses the nightly toolchain with warnings denied to catch
documentation issues early in CI.

Signed-off-by: Simo Sorce <simo@redhat.com>
@simo5
Copy link
Copy Markdown
Member Author

simo5 commented Apr 14, 2026

This can't work until ubuntu-latest is updated to a distro that has at least openssl 3.2 ..., so pausing this effort.

@simo5 simo5 marked this pull request as draft April 14, 2026 17:08
@simo5 simo5 added the deferred Will be finished later label Apr 14, 2026
@latchset latchset deleted a comment from gemini-code-assist Bot Apr 30, 2026
@simo5
Copy link
Copy Markdown
Member Author

simo5 commented Apr 30, 2026

/gemini review

@gemini-code-assist
Copy link
Copy Markdown

Note

Gemini is unable to generate a review for this pull request due to the file types involved not being currently supported.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

deferred Will be finished later

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant