Skip to content

Commit

Permalink
document SKIP_NOTEBOOKS
Browse files Browse the repository at this point in the history
  • Loading branch information
Zeitsperre committed Sep 14, 2023
1 parent 2680516 commit 74b4dc1
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,12 @@ Ready to contribute? Here's how to set up `xscen` for local development.
$ cd docs/
$ make html

.. note::

When building the documentation, the default behaviour is to evaluate notebooks ('nbsphinx_execute = "always"'), rather than simply parse the content ('nbsphinx_execute = "never"'). Due to their complexity, this can sometimes be a very computationally demanding task and should only be performed when necessary (i.e.: when the notebooks have been modified).

In order to speed up documentation builds, setting a value for the environment variable "SKIP_NOTEBOOKS" (e.g. "$ export SKIP_NOTEBOOKS=1") will prevent the notebooks from being evaluated on all subsequent "$ tox -e docs" or "$ make docs" invocations.

8. Submit a pull request through the GitHub website.

Pull Request Guidelines
Expand Down

0 comments on commit 74b4dc1

Please sign in to comment.