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

workflow for publishing docs #482

Closed
wants to merge 4 commits into from
Closed

Conversation

rscohn2
Copy link
Member

@rscohn2 rscohn2 commented May 10, 2024

Description

Build/publish documentation automatically when merging to develop. To enable this workflow, someone with admin rights needs to click settings/pages. And then change the "source" to "GitHub Actions"

Partially addresses #459. I also wasted time following the conan instructions, then found that conan support was dropped. I also saw that someone had updated the documentation to reflect the change. But I never saw that because the new documentation was not published. The published documentation has not been updated for 2 years!

.github/workflows/pr.yml Outdated Show resolved Hide resolved
@@ -0,0 +1 @@
Sphinx
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it possible to move this requirement document to doc? So that it will be clear that it's requirements only for Documentation, not for the full oneMKL build.

@dnhsieh-intel
Copy link
Contributor

Would it be sufficient to use "publishing from a branch"? We might also want to restrict publishing only when there are changes in the docs directory.

@rscohn2
Copy link
Member Author

rscohn2 commented May 14, 2024

It's a different implementation to publish from a branch. Publishing from a branch is a little more manual, but also more flexible. I can make the changes, but I would rather do it after #483 is merged. It will work better if there is a single workflow file so I can structure checks, unit tests, and doc publishing as CI jobs that depend on each other. With that in mind, I am closing this PR. It will help me to wrap this up if we can get #483 merged and I can add new CI jobs there.

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.

4 participants