Commit 765388c1 authored by Matthieu Boileau's avatar Matthieu Boileau

Update pages

parent 50a29e7d
Pipeline #7638 failed with stage
in 1 minute and 52 seconds
......@@ -5,7 +5,7 @@ parent: manual.md
## Download
[Download Anaconda](https://www.anaconda.com/download) for your operating system and install it.
Download [Anaconda](https://www.anaconda.com/download) for Python 3.X for your operating system and install it.
On Linux, open *Terminal* application and type:
......
---
title: Build and publish the course material
parent: manual.md
---
### Convert to html, slideshow and pdf
Use [nbcourse](https://gitlab.math.unistra.fr/boileau/nbcourse):
```bash
nbcourse list
build_book Build pdf book
build_pages Build html pages
convert_to_html Convert executed notebook to html page
convert_to_slides Convert executed notebook to reveal slides
copy_material Copy notebook and theme material to output directory
copy_reveal Copy reveal.js to output directory
execute_notebooks Write executed notebooks to output directory
output_dir Create empty output directory
zip_archive Build a single zip archive for all material
zip_chapters Build zip archives for single chapter downloads
```
Edit the `nbcourse.yml` file and run:
```bash
nbcourse [-n 4] [target] # [to run on 4 parallel threads]
```
The result will be located in `build/` directory.
### Publish with GitLab Pages
Publishing with [GitLab Pages](https://docs.gitlab.com/ee/user/project/pages/) is as simple as adding a `.gitlab-ci.yml` such as:
```yaml
pages:
image: boileaum/jupyter
script:
- pip install nbcourse
- nbcourse -n 5
- mv build public
artifacts:
paths:
- public
```
......@@ -37,32 +37,6 @@ conda install --file requirements.txt
jupyter-notebook
```
## Convert to html, slideshow and pdf
## Optional: build and publish
Use [nbcourse](https://gitlab.math.unistra.fr/boileau/nbcourse):
```bash
nbcourse list
build_book Build pdf book
build_pages Build html pages
convert_to_html Convert executed notebook to html page
convert_to_slides Convert executed notebook to reveal slides
copy_material Copy notebook and theme material to output directory
copy_reveal Copy reveal.js to output directory
execute_notebooks Write executed notebooks to output directory
output_dir Create empty output directory
zip_archive Build a single zip archive for all material
zip_chapters Build zip archives for single chapter downloads
```
Edit the `nbcourse.yml` file and run:
```bash
nbcourse [-n 4] <target> # [to run on 4 parallel threads]
```
The result will be located in `build/` directory.
## Publish with GitLab Pages
Thanks to [.gitlab-ci.yml](.gitlab-ci.yml) file, an online version may be automatically published at every `git push` towards a GitLab project.
If you want be able to build and publish this course material, follow these [instructions](pages/build.md).
.codehilite .hll { background-color: #ffffcc }
.codehilite { background: #f8f8f8; }
.codehilite .c { color: #408080; font-style: italic } /* Comment */
.codehilite .err { border: 1px solid #FF0000 } /* Error */
.codehilite .k { color: #008000; font-weight: bold } /* Keyword */
.codehilite .o { color: #666666 } /* Operator */
.codehilite .ch { color: #408080; font-style: italic } /* Comment.Hashbang */
.codehilite .cm { color: #408080; font-style: italic } /* Comment.Multiline */
.codehilite .cp { color: #BC7A00 } /* Comment.Preproc */
.codehilite .cpf { color: #408080; font-style: italic } /* Comment.PreprocFile */
.codehilite .c1 { color: #408080; font-style: italic } /* Comment.Single */
.codehilite .cs { color: #408080; font-style: italic } /* Comment.Special */
.codehilite .gd { color: #A00000 } /* Generic.Deleted */
.codehilite .ge { font-style: italic } /* Generic.Emph */
.codehilite .gr { color: #FF0000 } /* Generic.Error */
.codehilite .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.codehilite .gi { color: #00A000 } /* Generic.Inserted */
.codehilite .go { color: #888888 } /* Generic.Output */
.codehilite .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
.codehilite .gs { font-weight: bold } /* Generic.Strong */
.codehilite .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.codehilite .gt { color: #0044DD } /* Generic.Traceback */
.codehilite .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
.codehilite .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
.codehilite .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
.codehilite .kp { color: #008000 } /* Keyword.Pseudo */
.codehilite .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
.codehilite .kt { color: #B00040 } /* Keyword.Type */
.codehilite .m { color: #666666 } /* Literal.Number */
.codehilite .s { color: #BA2121 } /* Literal.String */
.codehilite .na { color: #7D9029 } /* Name.Attribute */
.codehilite .nb { color: #008000 } /* Name.Builtin */
.codehilite .nc { color: #0000FF; font-weight: bold } /* Name.Class */
.codehilite .no { color: #880000 } /* Name.Constant */
.codehilite .nd { color: #AA22FF } /* Name.Decorator */
.codehilite .ni { color: #999999; font-weight: bold } /* Name.Entity */
.codehilite .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
.codehilite .nf { color: #0000FF } /* Name.Function */
.codehilite .nl { color: #A0A000 } /* Name.Label */
.codehilite .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
.codehilite .nt { color: #008000; font-weight: bold } /* Name.Tag */
.codehilite .nv { color: #19177C } /* Name.Variable */
.codehilite .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
.codehilite .w { color: #bbbbbb } /* Text.Whitespace */
.codehilite .mb { color: #666666 } /* Literal.Number.Bin */
.codehilite .mf { color: #666666 } /* Literal.Number.Float */
.codehilite .mh { color: #666666 } /* Literal.Number.Hex */
.codehilite .mi { color: #666666 } /* Literal.Number.Integer */
.codehilite .mo { color: #666666 } /* Literal.Number.Oct */
.codehilite .sa { color: #BA2121 } /* Literal.String.Affix */
.codehilite .sb { color: #BA2121 } /* Literal.String.Backtick */
.codehilite .sc { color: #BA2121 } /* Literal.String.Char */
.codehilite .dl { color: #BA2121 } /* Literal.String.Delimiter */
.codehilite .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
.codehilite .s2 { color: #BA2121 } /* Literal.String.Double */
.codehilite .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
.codehilite .sh { color: #BA2121 } /* Literal.String.Heredoc */
.codehilite .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
.codehilite .sx { color: #008000 } /* Literal.String.Other */
.codehilite .sr { color: #BB6688 } /* Literal.String.Regex */
.codehilite .s1 { color: #BA2121 } /* Literal.String.Single */
.codehilite .ss { color: #19177C } /* Literal.String.Symbol */
.codehilite .bp { color: #008000 } /* Name.Builtin.Pseudo */
.codehilite .fm { color: #0000FF } /* Name.Function.Magic */
.codehilite .vc { color: #19177C } /* Name.Variable.Class */
.codehilite .vg { color: #19177C } /* Name.Variable.Global */
.codehilite .vi { color: #19177C } /* Name.Variable.Instance */
.codehilite .vm { color: #19177C } /* Name.Variable.Magic */
.codehilite .il { color: #666666 } /* Literal.Number.Integer.Long */
......@@ -3,6 +3,7 @@
<head><meta charset="utf-8" />
<title>{{ title }}</title>
<link rel="stylesheet" href="css/style.css">
<link rel="stylesheet" href="css/codehilite/default.css">
<link rel="icon" type="image/x-icon" href="{% if favicon %}{{ favicon }}{% else %}img/favicon-notebook.ico{% endif %}">
</head>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment