How to skip some cells?

[wookayin]

This is really a great plugin for sphinx!

I am curious how we can skip some cells from ipython notebooks that we mark using some comments, directives, or cell metadata to be excluded in converting. This would be super useful in writing documentations when we want to exclude some preambles or dirty data preparation codes from the rendered sphinx docs.

I don't think ipython nbconvert does have this feature :)

[mgeier]

Thanks!

Is https://nbsphinx.readthedocs.io/en/0.4.2/hidden-cells.html what you need?

when we want to exclude some preambles or dirty data preparation codes

Well it would probably be better to clean up the preparation code, wouldn't it?

And did you consider moving the (clean) preparation code to a separate .py file and then using import to work with it in your notebook?

I don't think ipython nbconvert does have this feature :)

In fact, there are multiple ways to do this in nbconvert:

By regex with https://nbconvert.readthedocs.io/en/latest/api/preprocessors.html#nbconvert.preprocessors.RegexRemovePreprocessor

By tags with TagRemovePreprocessor.remove_cell_tags and TagRemovePreprocessor.remove_input_tags (see https://nbconvert.readthedocs.io/en/latest/config_options.html)

[wookayin]

This works so great, sorry for missing that!

[ratnanil]

I'd be very interested to use nbconvert.preprocessors.RegexRemovePreprocessor. Can this funcionality be used within nbsphinx? I cant find anything in the docs..

[ratnanil]

It seems that nbconvert.preprocessors.RegexRemovePreprocessor is disabled (see below, and also #305 (comment)). Does this mean that I cannot use RegexRemovePreprocessor?

nbsphinx/src/nbsphinx.py

Lines 722 to 726 in 880bf3a

	config=traitlets.config.Config({
	'HighlightMagicsPreprocessor': {'enabled': True},
	# Work around https://github.com/jupyter/nbconvert/issues/720:
	'RegexRemovePreprocessor': {'enabled': False},
	}),

[mgeier]

@ratnanil See my answer at #341 (comment).