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

added GH action for generating docs on release #120

Merged

Conversation

erickmartins
Copy link
Collaborator

Description

This PR adds a github action for generating documentation on release using Sphinx and force-pushing it to the documentation branch. It will require a minor change in repository settings (from deploying github pages from the docs directory to root directory in the documentation branch). It also allows this action to be run on-demand when a documentation update is necessary.

Checklist

For reviewers

  • Check that the PR title is short, concise, and will make sense 1 year
    later.
  • Check that new functions are imported in corresponding __init__.py.

@govekk
Copy link
Collaborator

govekk commented Oct 29, 2024

Looks good to me!

@erickmartins erickmartins merged commit b463eea into TheJacksonLaboratory:main Oct 30, 2024
1 check passed
@erickmartins erickmartins deleted the documentation_action branch October 30, 2024 14:19
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