Skip to content

Commit a7b5376

Browse files
authored
Remove GH artifact action and update workflow for gh-pages (#81)
1 parent cc60f08 commit a7b5376

File tree

3 files changed

+17
-22
lines changed

3 files changed

+17
-22
lines changed

.github/workflows/artifacts.yml

Lines changed: 0 additions & 12 deletions
This file was deleted.

.github/workflows/docs.yml

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@ name: deploy-book
44
on:
55
push:
66
branches:
7-
- master
7+
- master
8+
pull_request:
9+
branches:
10+
- master
811

912
# Allow the bot to push to the repository
1013
permissions:
@@ -23,18 +26,14 @@ jobs:
2326
with:
2427
python-version: 3.7
2528

26-
- name: Install dependencies
27-
run: |
28-
pip install -U jupyter-book
29-
30-
31-
# Build the book
32-
- name: Build the book
29+
- name: Build the docs
3330
run: |
34-
jupyter-book build .
31+
pip install nox
32+
nox -s docs
3533
3634
# Push the book's HTML to github-pages
37-
- name: GitHub Pages action
35+
- if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
36+
name: GitHub Pages action
3837
uses: peaceiris/[email protected]
3938
with:
4039
github_token: ${{ secrets.GITHUB_TOKEN }}

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,14 @@ In addition, read
4747
for guidance on the questions you should answer before officially submitting
4848
the JEP.
4949

50+
## Docs hosting
51+
52+
We use a GitHub action to build the documentation with Sphinx and push it to the `gh-pages` branch of the repository.
53+
This is then hosted at `jupyter.org/enhancement-proposals`.
54+
55+
We use a ReadTheDocs build to automatically generate **previews** of the documentation for Pull Requests.
56+
However this is not the publicly-hosted version of the documentation, it is just for PRs.
57+
5058
## Build the enhancement proposal docs
5159

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

0 commit comments

Comments
 (0)