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

Mdip/docs-action #173

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
47 changes: 47 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Publish GillesPy2 Docs

on:
push:
branches: [develop]

jobs:
publish:
runs-on: ubuntu-latest

steps:
- name: Initialize environment
uses: actions/checkout@v2
with:
ref: develop
fetch-depth: 0

- name: Install Python
uses: actions/setup-python@v2
with:
python-version: '3.10'

- name: Install Sphinx Dependency
run: |
python3 -m pip install --upgrade pip
python3 -m pip install -U sphinx
python3 -m pip install numpy
python3 -m pip install -r requirements.txt
- name: Refresh Repository
working-directory: .
run: |
git pull origin develop
- name: Update the Docs
working-directory: docs
run: |
make html
- name: Commit Changes
working-directory: docs
run: |
git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
git config --local user.name "github-actions[bot]"
make commit-docs
- name: Push Changes
uses: ad-m/github-push-action@master
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
branch: develop
11 changes: 6 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -142,13 +142,14 @@ Thumbs.db #thumbnail cache on Windows
# profiling data
.prof


### vscode ###
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
*.code-workspace

# StochSS-Compute
**/dask-worker-space
**/cache/

# Development team
**/.mdip/
bs*