构建一个小型示例项目

构建一个小型示例项目#

现在你已经构建了第一本书,你可能希望从更“完整”的示例书籍中获得一些灵感。

本节描述了 QuantEcom 迷你书,展示了它是如何制作的。

展示的一些功能包括:

See also

更多灵感和示例书籍,请参见 Jupyter Book 画廊

迷你书源文件#

源文件可以在 GitHub 上的 docs 目录 中找到。 这些文件是用 MyST Markdown 编写的,这是 Jupyter Notebook Markdown 的一个扩展,允许额外的科学标记。它们也可以直接作为 Jupyter 笔记本编写。

构建演示书#

你可以通过以下步骤在命令行本地构建这本书:

  1. 确保你已安装了最新版本的 Anaconda Python

  2. 克隆包含演示书源文件的仓库

    git clone https://github.com/executablebooks/quantecon-mini-example
    cd quantecon-mini-example
    
  3. environment.yml 文件 安装运行此特定示例代码所需的 Python 库。这包括最新版本的 Jupyter Book:

    conda env create -f environment.yml
    conda activate qe-mini-example
    
  4. 在源文件上运行 Jupyter Book

    jupyter-book build ./mini_book
    
  5. 通过浏览器查看结果——尝试(例如,使用 firefox)

    firefox mini_book/_build/html/index.html
    

    (或直接双击 html 文件)

现在你可能会想尝试编辑 mini_book/docs 中的文件,然后重新构建。

进一步阅读#

请参见 完整的 QuantEcon 示例,这是一个更长的 Jupyter Book 用例,源自相同的源材料。