Skip to content

Commit

Permalink
Add latest version - more content and add jupyter-book
Browse files Browse the repository at this point in the history
  • Loading branch information
finsberg committed Feb 16, 2024
1 parent 2baf74e commit 3a17b4c
Show file tree
Hide file tree
Showing 11 changed files with 534 additions and 5,014 deletions.
19 changes: 17 additions & 2 deletions .github/workflows/build_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,30 @@ jobs:
- name: Checkout
uses: actions/checkout@v4


- name: Setup python
uses: actions/setup-python@v4
with:
python-version: '3.10'

- name: Install dependencies
run: |
python3 -m pip install .
- name: Build docs
run: jupyter book build .

- name: Use Node v18
uses: actions/setup-node@v4
with:
node-version: 18

- name: Build slides
run: |
npx @marp-team/marp-cli slides.md --html -o ${{ env.PUBLISH_DIR }}/index.html
cp figures/*.png ${{ env.PUBLISH_DIR }}/
for doc in $(ls docs/*.md); do
npx @marp-team/marp-cli ${doc} --html -o ${{ env.PUBLISH_DIR }}/$(basename ${doc::-3})-slides.html
done
cp -r docs/figures ${{ env.PUBLISH_DIR }}/
- name: Upload artifact
uses: actions/upload-artifact@v3
Expand Down
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
slides.html
.DS_Store
*.html
42 changes: 42 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Book settings
# Learn more at https://jupyterbook.org/customize/config.html

title: PhD Retreat 19.03.2024
author: Henrik Finsberg
logo: "docs/figures/logo.png"
copyright: "2024"
only_build_toc_files: true


execute:
execute_notebooks: cache
timeout: 3000

# Information about where the book exists on the web
repository:
url: https://github.com/scientificcomputing/phd-retreat-190324 # Online location of your book
branch: main


html:
use_issues_button: true
use_repository_button: true

parse:
myst_enable_extensions:
- amsmath
- dollarmath
- linkify
- html_image

sphinx:

config:
html_last_updated_fmt: "%b %d, %Y"

extra_extensions:
- 'sphinx.ext.autodoc'
- 'sphinx.ext.napoleon'
- 'sphinx.ext.viewcode'

exclude_patterns: [".*/*"]
7 changes: 7 additions & 0 deletions _toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
format: jb-article
root: README

sections:
- file: docs/intro
- file: docs/organizing
- file: docs/recording-computations
Binary file removed docs/figures/cc-license-chart.png
Binary file not shown.
Binary file added docs/figures/reasons-reproducibility.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 3a17b4c

Please sign in to comment.