Build a small example project
Build a small example project#
Now that you’ve built your first book, you may wish to get some inspiration from a more “complete” book example.
This section describes the QuantEcom mini book to show you how it’s made.
Some of the features on display include
numbered figures with captions and cross-referencing
For more inspiration and example books, see the Jupyter Book gallery
Mini-book source files#
The source files can be found on GitHub in the docs directory. These files are written in MyST Markdown, an extension of the Jupyter Notebook Markdown, that allows for additional scientific markup. They could alternatively have been written directly as Jupyter notebooks.
Build the demo book#
You can build this book locally on the command line via the following steps:
Ensure you have a recent version of Anaconda Python installed.
Clone the repository containing the demo book source files
git clone https://github.com/executablebooks/quantecon-mini-example cd quantecon-mini-example
Install the Python libraries needed to run the code in this particular example from the
environment.ymlfile. This includes the latest version of Jupyter Book:
conda env create -f environment.yml conda activate qe-mini-example
Run Jupyter Book over the source files
jupyter-book build ./mini_book
View the result through a browser — try (with, say, firefox)
(or simply double-click on the
Now you might like to try editing the files in
mini_book/docs and then
See the full QuantEcon example for a longer Jupyter Book use case, drawn from the same source material.