Build JupyterGIS documentation locally

Tip

You can use conda or mamba as drop-in replacements for micromamba in the steps below, but they will not be as fast.

0. Build JupyterGIS JavaScript packages

Follow the development environment setup instructions through running jlpm run build from the root of the repo.

Important

Navigate to the docs/ directory before starting any of the following steps!

1. Create the docs environment from environment-docs.yml

Important

Ensure all other environments are deactivated first!

micromamba create -f environment-docs.yml

2. Activate the jupytergis-docs environment

micromamba activate jupytergis-docs

3. Build the documentation

Note

You may experience failure at this step. Carefully read the last message. Did the build fail due to warnings? You may need to search the full log output for “WARNING” to find the cause.

./build.sh

4. Open the documentation

Once the build is successful, open:

_build/html/index.html

5. Repeat!

Every time you make edits to documentation, repeat steps 3 and 4.