Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create an option to build docs without executing notebooks #1282

Closed
jaladh-singhal opened this issue Aug 21, 2020 · 2 comments
Closed

Create an option to build docs without executing notebooks #1282

jaladh-singhal opened this issue Aug 21, 2020 · 2 comments

Comments

@jaladh-singhal
Copy link
Member

Currently, whenever docs are build, the notebooks which are marked to be executed by nbsphinx make build time very long - since each of them runs simulation model. This is fine for production but for development this becomes really annoying.

So there must be some option or flag while running make html or python -m sphinx build to explicitly disable notebooks' execution by nbsphinx on run-time.

Based on my very brief search, nbsphinx doesn't provide any such option for execute control during run-time but only for conf.py and individual notebook's metadata. But I believe, there should be a way to implement this, by adding some if-else logic in conf.py for nbsphinx execute setting which listens to flag specified to build command or something like that.

@epassaro
Copy link
Member

epassaro commented Oct 5, 2020

The default way to execute cells while rendering notebooks with nbsphinx is to leave all cells blank. If some cell is already executed then the notebook is not executed.

I understand the TARDIS documentation relies on notebook metadata to always execute the notebook and ignore the above method. Using this method and running once the Quickstart guide should be enough to build the documentation more quickly.

I don't know about a fancier way to do this.

@epassaro
Copy link
Member

epassaro commented Jun 3, 2021

Closed by #1615

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants