Ctrl+K

Construir el libro ejemplo

2. Construir el libro ejemplo#

Una vez que tenemos instalado Anaconda Python, tal y como hemos visto en el capítulo inicial, ya podemos crear nuestro primer libro.

2.1. Libro ejemplo#

Para ello, vamos a partir de este mismo ejemplo de libro interactivo creado con Jupyter Book, recreándolo a partir del repositorio que lo contiene en Github.

Algunas de las funcionalidades incluidas en este libro son:

Los ficheros se encuentran alojados en GitHub en la carpeta docs. El contenido está escrito en MyST markdown, una extensión de Jupyter notebook markdown que permite incluir markup científico, e incluye contenido escrito en Jupyter notebooks.

Construir el libro ejemplo

Para construir este libro ejemplo, vamos a hacerlo en Terminal, con los comandos siguientes:

  1. En primer lugar, vamos a crear un entorno virtual de trabajo donde instalar las librerías necesarias de Python para ejecutar el código fuente de nuestro primer libro. Una forma sencilla de hacerlo es a través de un fichero environment.yml, como veremos a continuación.

  2. Clonamos el repositorio de Github que contiene los ficheros del libro ejemplo:

    git clone https://github.com/Jero2760/jupyter-book-ejemplo/
cd jupyter-book-ejemplo

  3. Instalamos las librerías Python necesarias utilizando este fichero environment.yml . Además, también se instalará la última versión de Jupyter Book. Este es el contenido de nuestro fichero evironment.yml:

    name: jupyter-book-ejemplo
channels:
  - default
dependencies:
  - python=3.7
  - sphinx=2.4.4
  - pip
  - pandas
  - matplotlib
  - pip:
    - jupyter-book
    - sphinx-click
    - sphinx-tabs
    - jupytext
    - pyppeteer

    La instalación se lleva a cabo en Terminal, con los comandos:

    conda env create -f environment.yml
conda activate jupyter-book-ejemplo

    De esta forma, conseguimos instalar las dependencias necesarias, entre ellas Python 3.7 y la última versión de Jupyter Book, así como también hemos creado y activado un entorno virtual, llamado aquí jupyter-book-ejemplo, que nos permite tener un contexto aislado donde crear el libro ejemplo, sin interferencias con otros posibles entornos instalados en nuestro ordenador.

  4. Ejecutar Jupyter Book para generar el libro ejemplo, no desde la carpeta jupyter-book-ejemplo, sino desde la carpeta que lo contiene:

    cd ..
jupyter-book build jupyter-book-ejemplo/

  5. Ver el resultado en cualquier browser haciendo doble-click en el fichero html siguiente:

    jupyter-book-ejemplo/_build/html/index.html

    Ahora, podemos hacer modificaciones a los ficheros fuente que forman el libro ejemplo y que se encuentran en jupyter-book-ejemplo/docs. Para ver el resultado de nuestras modificaciones, se vuelve a generar el libro con el mismo comando build:

    jupyter-book build jupyter-book-ejemplo/

  6. Para salir del entorno virtual creado:

    conda deactivate

2.1.1. Más información#

Ver un libro completo muy informativo creado con Jupyter Book en QuantEcon con gran variedad de casos de uso.

Para más información sobre el proyecto Jupyter Book, ver toda la documentación en The Executable Book Project.

Contents