ENH: Build download notebooks using sphinx-tojupyter (#100)

* update configuration for download notebooks

* enable pdf production

* update ci, enable download notebooks

* update anaconda

* migrate to use jupyter raw directives

* add test run for theme branch

* fix test run of branch

* enable html targetting

* remove pdf templates and settings for now and deploy in a different PR

Author: mmcky

.github/workflows/ci.yml

@@ -7,14 +7,21 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Setup Anaconda
-        uses: goanpeca/setup-miniconda@v1
+        uses: conda-incubator/setup-miniconda@v2
         with:
           auto-update-conda: true
           auto-activate-base: true
           miniconda-version: 'latest'
           python-version: 3.8
           environment-file: environment.yml
-          activate-environment: qe-lectures
+          activate-environment: lecture-python-programming
+      - name: Install QuantEcon Book Theme
+        shell: bash -l {0}
+        run: |
+          git clone https://github.com/quantecon/quantecon-book-theme
+          cd quantecon-book-theme && git checkout download-nb
+          python setup.py install
+          cd .. && rm -r quantecon-book-theme
       - name: Display Conda Environment Versions
         shell: bash -l {0}
         run: conda list
@@ -25,6 +32,12 @@ jobs:
         shell: bash -l {0}
         run: |
           jb build lectures --path-output ./
+      - name: Build Download Notebooks (sphinx-tojupyter)
+        shell: bash -l {0}
+        run: |
+          jb build lectures --path-output ./ --builder=custom --custom-builder=jupyter
+          mkdir _build/html/_notebooks
+          cp _build/jupyter/*.ipynb _build/html/_notebooks
       - name: Preview Deploy to Netlify
         uses: nwtgck/actions-netlify@v1.1
         with:

.gitignore

@@ -1,3 +1,4 @@
 _build/
 __pycache__/
-.DS_Store
+.DS_Store
+dask-worker-space

environment.yml

@@ -1,16 +1,16 @@
-name: qe-lectures
+name: lecture-python-programming
 channels:
   - default
 dependencies:
   - python=3.8
   - anaconda=2020.07
   - pip
   - pip:
-    - jupyter-book
+    - git+https://github.com/executablebooks/jupyter-book.git
     - sphinxext-rediraffe
     - git+https://github.com/executablebooks/sphinx-multitoc-numbering
-    - git+https://github.com/quantecon/quantecon-book-theme
     - git+https://github.com/executablebooks/sphinx-exercise.git
     - joblib
     - interpolation
+    - git+https://github.com/QuantEcon/sphinx-tojupyter.git
 

lectures/_config.yml

@@ -12,7 +12,7 @@ html:
   baseurl: https://python.quantecon.org/
 
 sphinx:
-  extra_extensions: [sphinx_multitoc_numbering, sphinx_exercise, sphinxext.rediraffe]
+  extra_extensions: [sphinx_multitoc_numbering, sphinx_exercise, sphinxext.rediraffe, sphinx_tojupyter]
   config:
     html_favicon: _static/lectures-favicon.ico
     html_theme: quantecon_book_theme
@@ -29,3 +29,16 @@ sphinx:
       google_analytics_id: UA-54984338-9
     rediraffe_redirects:
       index_toc.md: intro.md
+    tojupyter_static_file_path: ["source/_static", "_static"]
+    tojupyter_target_html: true
+    tojupyter_urlpath: "https://python-programming.quantecon.org/"
+    tojupyter_image_urlpath: "https://python-programming.quantecon.org/_static/"
+    tojupyter_lang_synonyms: ["ipython", "ipython3", "python"]
+    tojupyter_kernels:
+      python3:
+        kernelspec:
+          display_name: "Python"
+          language: python3
+          name: python3
+        file_extension: ".py"
+    tojupyter_images_markdown: true

lectures/about_py.md

@@ -10,7 +10,7 @@ kernelspec:
 ---
 
 (about_py)=
-```{raw} html
+```{raw} jupyter
 <div id="qe-notebook-header" align="right" style="text-align:right;">
         <a href="https://quantecon.org/" title="quantecon.org">
                 <img style="width:250px;display:inline;" width="250px" src="https://assets.quantecon.org/img/qe-menubar-logo.svg" alt="QuantEcon">

lectures/debugging.md

@@ -10,7 +10,7 @@ kernelspec:
 ---
 
 (debugging)=
-```{raw} html
+```{raw} jupyter
 <div id="qe-notebook-header" align="right" style="text-align:right;">
         <a href="https://quantecon.org/" title="quantecon.org">
                 <img style="width:250px;display:inline;" width="250px" src="https://assets.quantecon.org/img/qe-menubar-logo.svg" alt="QuantEcon">

lectures/functions.md

@@ -10,7 +10,7 @@ kernelspec:
 ---
 
 (functions)=
-```{raw} html
+```{raw} jupyter
 <div id="qe-notebook-header" align="right" style="text-align:right;">
         <a href="https://quantecon.org/" title="quantecon.org">
                 <img style="width:250px;display:inline;" width="250px" src="https://assets.quantecon.org/img/qe-menubar-logo.svg" alt="QuantEcon">

lectures/getting_started.md

@@ -10,7 +10,7 @@ kernelspec:
 ---
 
 (getting_started)=
-```{raw} html
+```{raw} jupyter
 <div id="qe-notebook-header" align="right" style="text-align:right;">
         <a href="https://quantecon.org/" title="quantecon.org">
                 <img style="width:250px;display:inline;" width="250px" src="https://assets.quantecon.org/img/qe-menubar-logo.svg" alt="QuantEcon">

lectures/matplotlib.md

@@ -10,7 +10,7 @@ kernelspec:
 ---
 
 (matplotlib)=
-```{raw} html
+```{raw} jupyter
 <div id="qe-notebook-header" align="right" style="text-align:right;">
         <a href="https://quantecon.org/" title="quantecon.org">
                 <img style="width:250px;display:inline;" width="250px" src="https://assets.quantecon.org/img/qe-menubar-logo.svg" alt="QuantEcon">

lectures/need_for_speed.md

@@ -10,7 +10,7 @@ kernelspec:
 ---
 
 (speed)=
-```{raw} html
+```{raw} jupyter
 <div id="qe-notebook-header" align="right" style="text-align:right;">
         <a href="https://quantecon.org/" title="quantecon.org">
                 <img style="width:250px;display:inline;" width="250px" src="https://assets.quantecon.org/img/qe-menubar-logo.svg" alt="QuantEcon">