Skip to content

Latest commit

 

History

History
35 lines (18 loc) · 1.85 KB

README.md

File metadata and controls

35 lines (18 loc) · 1.85 KB

Template for publishing Julia Jupyter / Literate notebooks

Click Use this template button to copy this repository.

See also:

Notebook execution and publish via continuous integration (CI)

In ci.yml, Jupyter (*.ipynb) and Literate (*.jl) notebooks under the docs folder are executed in parallel, and then Jupyter book creates a beautiful website with notebook execution results.

Enable GitHub pages

Open your repository settings => Pages => GitHub Pages => Build and deployment => Source, select GitHub actions.

Automatic dependency updates

Dependabot and Kodiak Bot

See dependabot.yml and .kodiak.toml configuration files.

You need to enable the Kodiak Bot APP to automatically merge updates.

Julia dependencies

The Github workflow update-manifest.yml will regularly update Julia dependencies, make a PR with the updated packages, and automatically merge the updates if the notebooks are executed without error.

See the instructions for how to trigger CI workflows in a PR. This repo uses a custom GitHub APP to generate a token on the fly.

Checking web links

linkcheck.yml uses GitHub actions to regularly check if the web links in the notebooks are valid.