1. Modèle de livre avec Jupyter Book¶

Un modèle de livre créé avec Jupyter Book, en français et avec des exemples complets d’utilisations des extensions Sphinx, Jupyter et Jupyter Book les plus utiles.

Avertissement

Work in progress…

==> Voir https://perso.crans.org/besson/Info-Prepas-MP2I/Modele-de-livre-avec-Jupyter-Book/ pour la version actuelle de ce livre.

L”informatique n’est pas plus la science des ordinateurs que l’astronomie n’est celle des télescopes. – M. Fellows et I. Parberry (et pas Edger Dijkstra).

1.1. Usage¶

1.1.1. Building the book¶

If you’d like to develop on and build the Modèle de livre avec Jupyter Book book, you should:

Clone this repository and run
Note: if you have GNU Make installed, just do

$ make setupvenv
$ make html
$ make preview

Run pip install -r requirements.txt (it is recommended you do this within a virtual environment)
(Recommended) Remove the existing ./_build/ directory
Run jupyter-book build ./

A fully-rendered HTML version of the book will be built in ./_build/html/.

1.1.2. Hosting the book locally¶

WARNING: I don’t want to use any GitHub actions workflow: I want to compile my books locally, on my machine, and host them (without version control) on my websites.

The book is hosted at https://perso.crans.org/besson/Info-Prepas-MP2I/Modele-de-livre-avec-Jupyter-Book/

Why? Using automated build is not ecological friendly, I want to be in full control of the builds. And using GitHub pages for a book that changes very regularly is also unefficient. I will probably add this automated compilation of the books, when they will be mature enough, and when only the content will change, not the configurations.

1.1.3. Hosting the book on GitHub pages¶

The html version of the book is NOT hosted on the gh-pages branch of this repo. A GitHub actions workflow has been created that automatically builds and pushes the book to this branch on a push or pull request to main.

If you wish to disable this automation, you may remove the GitHub actions workflow and build the book manually by:

Navigating to your local build; and running,
ghp-import -n -p -f Modèle de livre avec Jupyter Book/_build/html

This will automatically push your build to the gh-pages branch. More information on this hosting process can be found here.

1.2. Contributors¶

We welcome and recognize all contributions. You can see a list of current contributors in the contributors tab.

1.3. Credits¶

This project is created using the excellent open source Jupyter Book project and the executablebooks/cookiecutter-jupyter-book template.

Informatique en MP2I au lycée Kléber - 2021-2022