Skip to content

Commit

Permalink
🚸 allow using raw RST cells in jupyter notebooks (#558)
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>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
burgholzer and pre-commit-ci[bot] authored Feb 23, 2024
1 parent 948d810 commit 1db2860
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 8 deletions.
5 changes: 5 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,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
8 changes: 0 additions & 8 deletions docs/quickstart.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -393,14 +393,6 @@
"mqt_qc = qiskit_to_mqt(qiskit_qc)\n",
"print(mqt_qc)"
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "d62ae1fde42917",
"metadata": {},
"outputs": [],
"source": []
}
],
"metadata": {
Expand Down

0 comments on commit 1db2860

Please sign in to comment.