Skip to content

馃懛 Documentation built through GitHub Actions - #80

Merged
alejandromolinaml merged 1 commit into
SPFlow:masterfrom
hayesall:docs_deploy
Jun 8, 2020
Merged

馃懛 Documentation built through GitHub Actions#80
alejandromolinaml merged 1 commit into
SPFlow:masterfrom
hayesall:docs_deploy

Conversation

@hayesall

@hayesall hayesall commented Jun 7, 2020

Copy link
Copy Markdown

Add .github/workflows/deploy_pages.yml

This action builds on the documentation rework in
Pull Request #79. This workflow:

  1. Runs when changes are pushed to the master branch
  2. Clones the repository
  3. Sets up Python
  4. Installs dependencies and runs make html
  5. Deploys docs/build/html/ on a gh-pages branch

The GitHub repository settings may be configured to
serve the contents of the gh-pages branch, so the
main site will still be built from the
spflow.github.io repository, and accessed at:

  • https://spflow.github.io/

... while the documentation will be served from:

  • https://spflow.github.io/SPFlow/

Add `.github/workflows/deploy_pages.yml`

This action builds on the documentation rework in
Pull Request SPFlow#79. This workflow:

1. Runs when changes are pushed to the `master` branch
2. Clones the repository
3. Sets up Python
4. Installs dependencies and runs `make html`
5. Deploys `docs/build/html/` on a `gh-pages` branch

The GitHub repository settings may be configured to
serve the contents of the `gh-pages` branch, so the
main site will still be built from the
`spflow.github.io` repository, and accessed at:

- `https://spflow.github.io/`

... while the documentation will be served from:

- `https://spflow.github.io/SPFlow/`
@hayesall

hayesall commented Jun 7, 2020

Copy link
Copy Markdown
Author

A demo showing how this might work is currently online in the IUProHealth organization:

Repository (Source) Site (Deployed)
https://github.com/iuprohealth/iuprohealth.github.io/ https://iuprohealth.github.io/
https://github.com/iuprohealth/sphinx-demo/ https://iuprohealth.github.io/sphinx-demo/

Repository Settings:

iuprohealth.github.io sphinx-demo
iuprohealth github io sphinx-demo

There's a separate Pull Request in the spflow.github.io which will add links to the main page:

@hayesall
hayesall marked this pull request as ready for review June 8, 2020 00:46
@alejandromolinaml
alejandromolinaml merged commit 3b95017 into SPFlow:master Jun 8, 2020
hayesall added a commit to hayesall/SPFlow that referenced this pull request Jun 8, 2020
Start building docs against Python 3.6
Add `sudo apt-get install -y graphviz` to install

This corrects two oversights made in Pull Request
SPFlow#80
@hayesall
hayesall deleted the docs_deploy branch June 8, 2020 14:19
braun-steven pushed a commit that referenced this pull request Nov 7, 2025
馃懛 Documentation built through GitHub Actions

Former-commit-id: 3b95017
braun-steven pushed a commit that referenced this pull request Nov 7, 2025
Start building docs against Python 3.6
Add `sudo apt-get install -y graphviz` to install

This corrects two oversights made in Pull Request
#80

Former-commit-id: 1ab820a
braun-steven pushed a commit that referenced this pull request Nov 7, 2025
馃懛 Documentation built through GitHub Actions

Former-commit-id: 1282e16
braun-steven pushed a commit that referenced this pull request Nov 7, 2025
Start building docs against Python 3.6
Add `sudo apt-get install -y graphviz` to install

This corrects two oversights made in Pull Request
#80

Former-commit-id: 10fc1b8
braun-steven pushed a commit that referenced this pull request Nov 7, 2025
馃懛 Documentation built through GitHub Actions

Former-commit-id: 01276d9
braun-steven pushed a commit that referenced this pull request Nov 7, 2025
Start building docs against Python 3.6
Add `sudo apt-get install -y graphviz` to install

This corrects two oversights made in Pull Request
#80

Former-commit-id: fcbb263
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