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

Upload built docs for on PR CI builds #21829

Closed
asmeurer opened this issue Aug 5, 2021 · 4 comments
Closed

Upload built docs for on PR CI builds #21829

asmeurer opened this issue Aug 5, 2021 · 4 comments
Labels
Documentation GitHub Actions Related to the GitHub Actions CI setup. Do not use for test failures unless they are GHA specific.

Comments

@asmeurer
Copy link
Member

asmeurer commented Aug 5, 2021

If you look at the matplotlib CI, they have a special build that builds their docs and uploads them somewhere. For example, go to some matplotlib PR https://github.com/matplotlib/matplotlib/pulls and click the "Check the rendered docs here!" build in the checks section at the bottom.

I think they are using a combination of GitHub Actions and Circle CI. CC Matplotlib devs @tacaswell @story645 @QuLogic. How hard would it be to just copy what matplotlib is using to SymPy?

@asmeurer asmeurer added Documentation GitHub Actions Related to the GitHub Actions CI setup. Do not use for test failures unless they are GHA specific. labels Aug 5, 2021
@story645
Copy link

story645 commented Aug 5, 2021

@larsoner most recently touched this in #20680 which relies on https://github.com/marketplace/actions/run-circleci-artifacts-redirector and looks to be fairly general?

@larsoner
Copy link

larsoner commented Aug 5, 2021

How hard would it be to just copy what matplotlib is using to SymPy?

The redirector step is just about trivial. Getting docs to build with artifacts on CircleCI is also fairly easy (IMO) for someone familiar with CIs

looks to be fairly general?

Yep, create CircleCI artifacts and you can use run-circleci-artifacts-redirector / circleci-artifacts-redirector-action. The GitHub action just saves a couple of clicks from the standard CircleCI page where you'd have to login via GitHub, then click the "artifacts" tab, then click a link.

So far I think it's used by NumPy, SciPy, matplotlib, etc. so should hopefully work for you, too!

@oscargus
Copy link
Contributor

I think it may be possible to do using https://github.com/actions/upload-artifact as well.

If I get it right (which I may not), there will be an artifact for the sphinx build then and not as nice at matplotlib where you have it clearly visible in the test list.

@asmeurer
Copy link
Member Author

#23460

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation GitHub Actions Related to the GitHub Actions CI setup. Do not use for test failures unless they are GHA specific.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants