Skip to content

Commit

Permalink
🚸 allow using raw RST cells in jupyter notebooks (#433)
Browse files Browse the repository at this point in the history
## Description

This PR updates the jupyter notebook cleaning pre-commit check to
preserve MIME metadata. This allows to use raw RST cells within jupyter
notebooks, which can be very helpful for using Sphinx references as part
of the documentation.

## Checklist:

<!---
This checklist serves as a reminder of a couple of things that ensure
your pull request will be merged swiftly.
-->

- [x] The pull request only contains commits that are related to it.
- [x] I have added appropriate tests and documentation.
- [x] I have made sure that all CI jobs on GitHub pass.
- [x] The pull request introduces no new warnings and follows the
project's style guidelines.

Signed-off-by: burgholzer <burgholzer@me.com>
  • Loading branch information
burgholzer authored Feb 23, 2024
1 parent 69bfbcc commit ee2caaf
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@ repos:
rev: 3.2.0
hooks:
- id: nb-clean
args:
- --remove-empty-cells
- --preserve-cell-metadata
- raw_mimetype
- --

# Handling unwanted unicode characters
- repo: https://github.com/sirosen/texthooks
Expand Down

0 comments on commit ee2caaf

Please sign in to comment.