(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
- Jupyter Notebook-style inputs and outputs
- citations
- numbered equations
- numbered figures with captions and cross-referencing
:::{seealso} For more inspiration and example books, see the Jupyter Book gallery :::
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.
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
If you'd like to install Jupyter Book with `pip`, you can do so with: ```bash pip install -U jupyter-book ``` See [the getting started page](../start/overview.md) for more information.
-
Install the Python libraries needed to run the code in this particular example from the
environment.yml
file. 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)
firefox mini_book/_build/html/index.html
(or simply double-click on the
html
file)
Now you might like to try editing the files in mini_book/docs
and then
rebuilding.
See the full QuantEcon example for a longer Jupyter Book use case, drawn from the same source material.