From 9eb7df209e43e993459c8307d25be6c5b67452e7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan-Hendrik=20M=C3=BCller?= <44469195+kolibril13@users.noreply.github.com> Date: Sat, 15 Apr 2023 16:58:18 +0200 Subject: [PATCH 1/3] error note --- docs/quickstart.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/quickstart.md b/docs/quickstart.md index c4c6b736..3d26aae2 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -38,10 +38,14 @@ Once you have finished authoring your content, you can now use the [sphinx-build sphinx-build -nW --keep-going -b html docs/ docs/_build/html ``` + :::{tip} MyST-NB is parallel-friendly, so you can also distribute the build (and execution of notebooks) over *N* processes with: `sphinx-build -j 4` ::: +In case that you experience the message "Extension error" in the build log, make sure you call the right sphinx-build command. For python virtual environments, that would be `.venv/bin/sphinx-build -nW --keep-going -b html docs/ docs/_build/html`. + + :::{seealso} Check out [Read the Docs](https://docs.readthedocs.io) for hosting and *continuous deployment* of documentation ::: From d7d57799018a65c2d18c658ed8f5ff869daec234 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan-Hendrik=20M=C3=BCller?= <44469195+kolibril13@users.noreply.github.com> Date: Sat, 15 Apr 2023 17:26:48 +0200 Subject: [PATCH 2/3] hyperlinkifyed --- docs/render/hiding.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/render/hiding.md b/docs/render/hiding.md index 5df13d32..4a8597f6 100644 --- a/docs/render/hiding.md +++ b/docs/render/hiding.md @@ -8,7 +8,7 @@ kernelspec: You can use Jupyter Notebook **cell tags** to control some of the behavior of the rendered notebook.[^download] -If you are using cell tags for the first time, you can read more about them in this tutorial https://jupyterbook.org/en/stable/content/metadata.html#add-metadata-to-notebooks +If you are using cell tags for the first time, you can read more about them in this tutorial [^download]: This notebook can be downloaded as **{nb-download}`hiding.ipynb`** and {download}`hiding.md` From 640b3b456388786e6ebef29131379aed865bc9a4 Mon Sep 17 00:00:00 2001 From: Chris Holdgraf Date: Fri, 21 Apr 2023 05:21:54 -0700 Subject: [PATCH 3/3] Update docs/quickstart.md --- docs/quickstart.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index 3d26aae2..b274ba1c 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -43,7 +43,11 @@ sphinx-build -nW --keep-going -b html docs/ docs/_build/html MyST-NB is parallel-friendly, so you can also distribute the build (and execution of notebooks) over *N* processes with: `sphinx-build -j 4` ::: -In case that you experience the message "Extension error" in the build log, make sure you call the right sphinx-build command. For python virtual environments, that would be `.venv/bin/sphinx-build -nW --keep-going -b html docs/ docs/_build/html`. +```{admonition} The execution environment is the same as your Sphinx environment +Your Sphinx build shares the same environment with the notebooks you execute during a build. +Ensure that you call the correct `sphinx-build` command when building your documentation, or the environment needed to run the notebooks may not be correct. +This often happens if you see an `Extension error` in the build log, or an error from `jupyter-cache`. +``` :::{seealso}