Skip to content

Fix documentation generation #1706

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

Merged
merged 1 commit into from
Jan 22, 2023
Merged

Conversation

Conengmo
Copy link
Member

I noticed our documentation hasn't been updated since we moved away from Travis. Probably something wrong in our Github Actions workflow. I noticed we don't run the workflow on release, could that be the issue? To possibly solve this I copied the triggers from the 'Publish to PyPI' workflow.

If this would indeed solve the issue, I suspect we would then have to do a release to update the documentation. Or should I just run the documentation and update the gh-pages branch manually?

@Conengmo Conengmo requested a review from ocefpaf January 21, 2023 14:03
Comment on lines +4 to +7
pull_request:
push:
branches:
- main
Copy link
Collaborator

Choose a reason for hiding this comment

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

These will not do much apart from checking if sphinx did not fail as the last step will run only on release. But the lines below are needed here.

@martinfleis
Copy link
Collaborator

If this would indeed solve the issue, I suspect we would then have to do a release to update the documentation. Or should I just run the documentation and update the gh-pages branch manually?

I would run it manually and push to the branch.

@Conengmo
Copy link
Member Author

Thanks for the review Martin. I'll run the docs manually and add a PR to add them to the gh-pages branch. Then also merge this so we have the 'on release' trigger for our next release.

These will not do much apart from checking if sphinx did not fail as the last step will run only on release

Agreed, but I suppose it's nice to check that on each PR.

@Conengmo Conengmo removed the request for review from ocefpaf January 21, 2023 15:52
@Conengmo Conengmo merged commit 5386dc1 into python-visualization:main Jan 22, 2023
@Conengmo Conengmo deleted the fix-docs branch January 22, 2023 14:28
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.

2 participants