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

Remove GH artifact action and update workflow for gh-pages #81

Merged
merged 3 commits into from
Dec 2, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 0 additions & 12 deletions .github/workflows/artifacts.yml

This file was deleted.

19 changes: 9 additions & 10 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ name: deploy-book
on:
push:
branches:
- master
- master
pull_request:
branches:
- master

# Allow the bot to push to the repository
permissions:
Expand All @@ -23,18 +26,14 @@ jobs:
with:
python-version: 3.7

- name: Install dependencies
run: |
pip install -U jupyter-book


# Build the book
- name: Build the book
- name: Build the docs
run: |
jupyter-book build .
pip install nox
nox -s docs

# Push the book's HTML to github-pages
- name: GitHub Pages action
- if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
name: GitHub Pages action
uses: peaceiris/actions-gh-pages@v3.5.9
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,14 @@ In addition, read
for guidance on the questions you should answer before officially submitting
the JEP.

## Docs hosting

We use a GitHub action to build the documentation with Sphinx and push it to the `gh-pages` branch of the repository.
This is then hosted at `jupyter.org/enhancement-proposals`.

We use a ReadTheDocs build to automatically generate **previews** of the documentation for Pull Requests.
However this is not the publicly-hosted version of the documentation, it is just for PRs.

## Build the enhancement proposal docs

The Enhancement Proposal documentation is structured as a [Sphinx documentation site](https://www.sphinx-doc.org/) that uses a them and configuration inspired by [Jupyter Book](https://jupyterbook.org).
Expand Down