search

sandialabs / sdynpy

A Structural Dynamics Python Library
Other
22 stars 0 forks source link

pages workflow #2

Closed mrbuche closed 1 year ago

mrbuche commented 1 year ago

This workflow builds and deploys the documentation to GitHub pages. It also makes a pylint badge.

You can check out how it will look here: https://mrbuche.github.io/sdynpy/

It builds the documentation on any PR's to the main branch so that you can check it before pulling it in. It only deploys to GitHub pages when the main branch is committed to.

After merging this PR, you just need to go to

https://github.com/sandialabs/sdynpy/settings/pages

and make the branch that 'Deploy from a branch' will use to be 'gh-pages'

mrbuche commented 1 year ago

Check out the above! The main (tests) workflow runs during pull requests, and so does the docs build, but not the docs deploy (skipped!). This way you can ensure anything merged into the main branch is passing. I even disable pushing directly to the main branch sometimes.