2021/12/02 Updated by

Jupyter Notebook: Bookの作成


[Up] Japanese English
  1. Anaconda promptを起動し、その中で以下の作業を行う。
  2. python 仮想環境をactivateせずに (base) 環境で途中まで作業する
  3. Bookを作成するフォルダに移動する。ここでは G:\マイドライブ\JupyterBook に作成するものとする。もしも、フォルダが存在しなければエクスプローラなどから作成しておく。
  4.     (base) C:\Users\nitta>  g:       
        (base) G:\>  cd マイドライブ       
        (base) G:\マイドライブ>  cd JupyterBook       
    
  5. github から サンプルをダウンロードする。Windowsの場合はブラウザでアクセスしてzipファイルとしてダウンロードし、解凍した方が簡単かもしれない。git コマンドがインストールしてあれば git clone してもよい。
  6. https://github.com/executablebooks/quantecon-mini-example
  7. Anaconda promptの対話環境で quantecon-mini-example フォルダに移動する。
  8.     (base) G:\マイドライブ\JupyterBook>  cd quantecon-mini-example       
    
  9. どのようなファイルがあるか調べる。
  10.     (base) G:\マイドライブ\JupyterBook\quantecon-mini-example>  dir       
         ドライブ G のボリューム ラベルは Google Drive です
         ボリューム シリアル番号は 1983-1116 です
        
         G:\マイドライブ\JupyterBook\quantecon-mini-example のディレクトリ
        
        2021/12/02  19:03    <DIR>          .
        2021/12/02  19:03    <DIR>          ..
        2021/06/06  18:26                60 .gitignore
        2021/06/06  18:26               162 environment.yml
        2021/06/06  18:26             1,099 README.md
        2021/06/06  18:26                47 requirements.txt
        2021/12/02  19:02    <DIR>          .github
        2021/12/02  19:02    <DIR>          mini_book
        2021/12/02  19:02    <DIR>          scripts
                       4 個のファイル               1,368 バイト
                       5 個のディレクトリ  128,314,707,968 バイトの空き領域
    
  11. quantecon-mini-example/README.md の記述にしたがってインストールを進めることになる。
  12. quantecon-mini-example/README.md
    # quantecon-mini-example
    
    A short example showing how to write a lecture series using Jupyter Book 2.0.
    
    ## Creating an Conda Environment
    
    The conda environment is provided as `environment.yml`. This environment is used for all testing by Github Actions and can be setup by:
    
    1. `conda env create -f environment.yml`
    2. `conda activate qe-mini-example`
    
    ## Building a Jupyter Book
    
    Run the following command in your terminal:
    
    ```bash
    jb build mini_book/
    ```
    
    If you would like to work with a clean build, you can empty the build folder by running:
    
    ```bash
    jb clean mini_book/
    ```
    
    If jupyter execution is cached, this command will not delete the cached folder. 
    
    To remove the build folder (including `cached` executables), you can run:
    
    ```bash
    jb clean --all mini_book/
    ```
    
    ## Publishing this Jupyter Book
    
    This repository is published automatically to `gh-pages` upon `push` to the `master` branch.
    
    ## Notes
    
    This repository is used as a test case for [jupyter-book](https://github.com/executablebooks/jupyter-book) and 
    a `requirements.txt` file is provided to support this `CI` application.
  13. ただし、現時点(2021/12/02)のWindows環境では、まず quantecon-mini-example/environment.yml の記述中の python=3.8 の部分を python=3.7に変更する必要がある。
  14. quantecon-mini-example/environment.yml の変更
    *** quantecon-mini-example/environment_org.yml	Thu Dec  2 23:36:17 2021
    --- quantecon-mini-example/environment.yml	Thu Dec  2 23:22:42 2021
    ***************
    *** 2,8 ****
      channels:
        - default
      dependencies:
    !   - python=3.8
        - sphinx
        - pip
        - pandas
    --- 2,8 ----
      channels:
        - default
      dependencies:
    !   - python=3.7
        - sphinx
        - pip
        - pandas
    
  15.     (base) G:\マイドライブ\JupyterBook\quantecon-mini-example>  cd quantecon-mini-example        
        (base) G:\マイドライブ\JupyterBook\quantecon-mini-example>  conda env create -f environment.yml       
        (base) G:\マイドライブ\JupyterBook\quantecon-mini-example>  conda activate qe-mini-example       
        (base) G:\マイドライブ\JupyterBook\quantecon-mini-example>  jupyter-book build mini_book/       
    
  16. quantecon-mini-example/mini_book/_build/{html, jupyter_execute} にファイルが生成されている。