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

DOC: conflict with myst_parser, hiding cells with LaTeX #622

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ extensions = [

By default, MyST-NB will now parse both markdown (`.md`) and notebooks (`.ipynb`).

If you used the `myst_parser` extension already, remove it from the extension list to avoid conflict — it is imported by `myst_nb` automatically; all its options, such as `myst_enable_extension`, will be processed.


```{button-ref} authoring/intro
:ref-type: myst
:color: primary
Expand Down
15 changes: 15 additions & 0 deletions docs/render/hiding.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,21 @@ print("hallo world")
print("hallo world")
```

### LaTeX output

Hiding cells in LaTeX output does nothing, unless further tweaks on the LaTeX side are in place.

Cell tags are helpfully propagated to the LaTeX source (e.g. `hide-cell` tag will wrap the cell inside the `\begin{sphinxuseclass}{tag_hide-cell}…\end{sphinxuseclass}`), but those classes, by default, do nothing. Adjust LaTeX preamble (in `conf.py`, editing `latex_elements` option and its `preamble` field) by adding e.g.

```{code-cell} latex

\NewDocumentEnvironment{HIDDEN}{+b}{}{} % defines a new environment HIDDEN which ignores its contents (no output)
\newenvironment{sphinxclasstag_hide-cell}{\begin{HIDDEN}}{\end{HIDDEN}} % this will be used by \begin{sphinxuseclass}{tag_hide-cell}…\end{sphinxuseclass}
```

to completely hide all cells with the `hide-cell` tag.


(use/hiding/markdown)=

## Hide markdown cells
Expand Down