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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃懛 Documentation built through GitHub Actions #80

Merged
merged 1 commit into from Jun 8, 2020

Conversation

hayesall
Copy link
Contributor

@hayesall hayesall commented Jun 7, 2020

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
Copy link
Contributor Author

hayesall commented Jun 7, 2020

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
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.

None yet

2 participants