Commit 6cda94e3 authored by Matthieu Boileau's avatar Matthieu Boileau
Browse files

Merge from dev-test

parents 0b816173 be64f589
......@@ -145,7 +145,7 @@ class MarkdownPage(Page):
"""Render markdown file into html file adding ToC"""
self.parent = parent
pattern = re.compile(r'^doc\/(.*)\.md$')
pattern = re.compile(r'^pages\/(.*)\.md$')
def markdown2html():
"""Return html from markdown file"""
......
......@@ -5,7 +5,7 @@ parent: home
## Execute the Jupyter notebooks
This course content is provided as Jupyter notebooks that require to be engined by a Jupyter server with Python3 kernel.
This course content is provided as Jupyter notebooks that require to be powered by a Jupyter server with Python3 kernel.
## Install Jupyter
......@@ -18,7 +18,7 @@ In particular, it is shipped with:
- The [Spyder](https://github.com/spyder-ide/spyder) IDE
- Scipy libraries: Numpy, Pandas, etc.
For a detailed installation of Anaconda and its extensions on Windows, Mac or Linux, follow the instructions <a href="doc/anaconda.md"><img src="fig/anaconda.png" style="display:inline" alt="Anaconda logo" width="100px"></a>.
For a detailed installation of Anaconda and its extensions on Windows, Mac or Linux, follow the instructions <a href="pages/anaconda.md"><img src="fig/anaconda.png" style="display:inline" alt="Anaconda logo" width="100px"></a>.
### Finalize installation with Pip
......@@ -42,22 +42,30 @@ jupyter-notebook
## Convert to html, slideshow and pdf
Use `make` :
Use [nbcourse](https://gitlab.math.unistra.fr/boileau/nbcourse):
```bash
make help
Please use `make <target>' where <target> is one of
html to make standalone HTML files
slides to make slideshows (use local_reveal=True to run them without internet connection)
pdf to compile all notebooks as a single PDF book
archives to make ##-notebook.zip files
archive to make cours-python.zip file
doc to make documentation
Use `make' to run all these targets
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
```
The result is located in `build/` directory.
Edit the `nbcourse.yml` file and run:
## Publish with Pages
```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.
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