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

Tutorials infrastructure: switch to sphinx+text-based notebook workflow #36

Merged
merged 11 commits into from
Nov 9, 2020
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
29 changes: 29 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# See: https://circleci.com/docs/2.0/language-python/

version: 2
jobs:
build:
working_directory: ~/repo
docker:
- image: circleci/python:3.8.5-buster

steps:
- checkout

- run:
name: Install Python dependencies
command: |
python3 -m venv venv
source venv/bin/activate
pip install --upgrade pip wheel setuptools
pip install -r requirements.txt
pip install -r site/requirements.txt

- run:
name: Build site
command: |
source venv/bin/activate
make -C site/ html

- store_artifacts:
path: site/_build/html
34 changes: 0 additions & 34 deletions .github/workflows/chatops.yaml

This file was deleted.

12 changes: 12 additions & 0 deletions .github/workflows/circleci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
on: [status]
jobs:
circleci_artifacts_redirector_job:
runs-on: ubuntu-latest
name: Run CircleCI artifacts redirector
steps:
- name: GitHub Action step
uses: larsoner/circleci-artifacts-redirector-action@master
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
artifact-path: 0/site/_build/html/index.html
circleci-jobs: build
37 changes: 0 additions & 37 deletions .github/workflows/nbval.yml

This file was deleted.

2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -90,3 +90,5 @@ Thumbs.db

# Things specific to this project #
###################################
site/_build/*
site/notebooks/*
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,21 +67,21 @@ Remember to clear all outputs on your notebook before uploading it.
<summary>
<b>Fork this repository</b> (if you haven't before).
</summary>
<img src="images/01-fork.gif" width=80% height=80%>
<img src="site/_static/01-fork.gif" width=80% height=80%>
</details>

<details>
<summary>
<b>In your own fork, create a new branch for your content.</b>
</summary>
<img src="images/02-create_new_branch.gif" width=80% height=80%>
<img src="site/_static/02-create_new_branch.gif" width=80% height=80%>
</details>

<details>
<summary>
<b>Add your notebook to the <code>content/</code> directory.</b>
</summary>
<img src="images/03-upload.gif" width=80% height=80%>
<img src="site/_static/03-upload.gif" width=80% height=80%>
</details>

<b>Update the <code>environment.yml</code> file with the dependencies for your tutorial</b>
Expand All @@ -91,7 +91,7 @@ Remember to clear all outputs on your notebook before uploading it.
<summary>
<b>Update this <code>README.md</code> to include your new entry.</b>
</summary>
<img src="images/04-add_to_readme.gif" width=80% height=80%>
<img src="site/_static/04-add_to_readme.gif" width=80% height=80%>
</details>

<b>Update the attribution section (below) to credit the original tutorial
Expand All @@ -101,7 +101,7 @@ author, if applicable.</b>
<summary>
<b>Create a <a href="https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests">pull request.</a></b>
</summary>
<img src="images/05-create_PR.gif" width=80% height=80%>
<img src="site/_static/05-create_PR.gif" width=80% height=80%>
</details>

:tada: <b>Wait for review!</b>
Expand Down
Loading