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

Build docs with docs deps and make #956

Merged
merged 4 commits into from
Jan 28, 2025

Conversation

mikemckiernan
Copy link
Member

Description

Build the docs for PRs, merges to develop, and tags.

Related Issue(s)

Checklist

  • I've read the CONTRIBUTING guidelines.
  • I've updated the documentation if applicable.
  • I've added tests if applicable.
  • @mentions of the person or team responsible for reviewing proposed changes.

@mikemckiernan mikemckiernan self-assigned this Jan 28, 2025
Signed-off-by: Mike McKiernan <[email protected]>
Signed-off-by: Mike McKiernan <[email protected]>
@mikemckiernan mikemckiernan added the documentation Improvements or additions to documentation label Jan 28, 2025
@mikemckiernan
Copy link
Member Author

I can't explain why the PR preview job isn't running and isn't visible. I'm OK with troubleshooting that after merging this one or #954.

The goal of this PR is so the engineers contributing to the project can choose what they feel is the best developer experience. I have a history of favoring containers for building docs, but if the dev experience is to use poetry and a venv, I'm game.

Copy link
Collaborator

@Pouyanpi Pouyanpi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is GREAT! 🥇
Thank you @mikemckiernan , let's merge it and see how it goest 👍🏻

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for later, maybe just trigger it when there is a change to docs dir, .md or rst file?

        paths:
            - 'docs/**'
            - '**/*.md'
            - '**/*.rst'

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is worth doing now, IMO.

Signed-off-by: Mike McKiernan <[email protected]>
@mikemckiernan mikemckiernan merged commit 71bcd2d into NVIDIA:develop Jan 28, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants