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

let sphinx.yml operate on a non-default docs location #30

Merged
merged 2 commits into from
Aug 14, 2024
Merged

Conversation

2bndy5
Copy link
Contributor

@2bndy5 2bndy5 commented Aug 14, 2024

This allows the calling workflow to specify where the docs folder is located.

The new input, project-root, is optional, so this will not break any current CI workflows. If project-root is set to anything other than the default ('.'), then the artifact name uses the input value instead of the repo's name.

Tip

This is handy for a monorepo (a repo that contains multiple projects). The cpp_linter_rs repo is a cargo workspace, which is like a monorepo.

This allows the calling workflow to specify where the docs folder is located.

The new input is optional, so this shouldn't break any current CI workflows.
@2bndy5
Copy link
Contributor Author

2bndy5 commented Aug 14, 2024

verified that this doesn't break current CI in cpp-linter/cpp-linter#112

@2bndy5 2bndy5 merged commit c5cd4d9 into main Aug 14, 2024
2 checks passed
@2bndy5 2bndy5 deleted the sphinx-root branch August 14, 2024 04:57
2bndy5 added a commit that referenced this pull request Aug 14, 2024
@2bndy5 2bndy5 mentioned this pull request Aug 14, 2024
2bndy5 added a commit that referenced this pull request Aug 14, 2024
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.

1 participant