This PR adds a .github/worlflows/ folder with three GitHub Actions.
check_black.yml: This GitHub action runs upon any commits to a PR and upon merge. It makes sure that all the Python files in the repository follow the black lint conventions. If they do not, just make sure you are in the ogind-dev conda environment, get to the root OG-IND directory in your terminal, and type black . -l 79.
deploy_docs.yml: This GH Action deploys the Jupyter Book documentation to the gh-pages branch of the repository, once a PR is merged. Once loaded to the gh-pages branch, this will automatically update the web documentation.
docs_check.yml: This GH Action runs on any commit to a PR and upon merge. It makes sure that the Jupyter Book documentation compiles.
This PR adds a
.github/worlflows/folder with three GitHub Actions.check_black.yml: This GitHub action runs upon any commits to a PR and upon merge. It makes sure that all the Python files in the repository follow theblacklint conventions. If they do not, just make sure you are in theogind-devconda environment, get to the rootOG-INDdirectory in your terminal, and typeblack . -l 79.deploy_docs.yml: This GH Action deploys the Jupyter Book documentation to thegh-pagesbranch of the repository, once a PR is merged. Once loaded to thegh-pagesbranch, this will automatically update the web documentation.docs_check.yml: This GH Action runs on any commit to a PR and upon merge. It makes sure that the Jupyter Book documentation compiles.