Skip to content

Commit

Permalink
Mention support for ipynb technotes
Browse files Browse the repository at this point in the history
  • Loading branch information
jonathansick committed Mar 26, 2024
1 parent 7d0d79d commit 18edacd
Showing 1 changed file with 1 addition and 15 deletions.
16 changes: 1 addition & 15 deletions changelog.d/20240326_120624_jsick_DM_43485.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,3 @@
<!-- Delete the sections that don't apply -->

### Backwards-incompatible changes

-

### New features

- Rubin user guides (`documenteer.conf.guide`) now include [MyST-NB](https://myst-nb.readthedocs.io/en/latest/) to support Jupyter Notebooks in Sphinx documentation. The MyST-NB extension also supersedes `MyST-Parser` for Markdown syntax support.

### Bug fixes

-

### Other changes

-
- Rubin user guides (`documenteer.conf.guide`) and technotes (`documenteer.conf.technote`) now include [MyST-NB](https://myst-nb.readthedocs.io/en/latest/) to support Jupyter Notebooks in Sphinx documentation. The MyST-NB extension also supersedes MyST-Parser for Markdown syntax support. For guides, Jupyter Notebook files can be intermixed with Markdown (`.md`) and reStructuredText (`.rst`) files. An `ipynb` file is considered as a page in the documentation. For technotes, the Jupyter Notebook must be named `index.ipynb`. By default, these configurations use MyST-NB's "auto" mode for notebook execution: only if a notebook is missing outputs will it be executed.

0 comments on commit 18edacd

Please sign in to comment.