From 6f43b72b04bf0b77f4bc5c43071282a32535c9a6 Mon Sep 17 00:00:00 2001 From: Seth Russell Date: Tue, 23 Nov 2021 08:34:09 -0700 Subject: [PATCH] Adding setup details for mapbox token to help with #3483 Build requires a mapbox token, but did not mention that in the documentation. This should help with issue #3483 --- doc/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/README.md b/doc/README.md index 4d4c71fd9d6..6362a8de3b1 100644 --- a/doc/README.md +++ b/doc/README.md @@ -65,7 +65,11 @@ Checklist ### Build process -Run `make` to build html pages for the tutorials. This uses `jupytext` to +This build process requries a free personal public mapbox token to work. + +First, create an account at https://account.mapbox.com/auth/signup Once that is done, navigate to https://account.mapbox.com/ and copy your "Default public token" to the file `doc/python/.mapbox_token` + +Next, run `make` to build html pages for the tutorials. This uses `jupytext` to execute the notebooks and `nbconvert` to convert notebook files to static html pages. Note that the CI will build the doc, so you don't have to build it yourself, it is enough to check that the markdown file runs correctly in