Skip to content

Notebook to jupyter sphinx converter for tutorials writing

Victor Negîrneac requested to merge notebook_to_jupyter_sphinx into develop

Explanation of changes

Adds a sphinx extension that allows to converts automatically .rst.py notebooks (in percent format) to rst files with .. jupyter-execute:: rst blocks.

See !212 (closed) on how this is currently used. See the module docstring for details.

Motivation of changes

Facilitate the creation/development/maintainability of tutorials/technical notes.

This avoids copy-pasting constantly code from a notebook into a .rst file.

This repo is not the ideal place to keep this extension in my opinion I would suggest merging it for now and creating an issue proposing it to the jupyter-sphinx folks. We remove it later if they accept it. Do you agree?

Merge checklist

See also merge request guidelines

  • Merge request has been reviewed and approved by a project maintainer.
  • Merge request contains a clear description of the proposed changes and the issue it addresses.
  • Merge request made onto appropriate branch (develop for most MRs).
  • New code is fully tested.
  • New code is documented and docstrings use numpydoc format.
  • Changelog has been updated (when applicable).
  • CI pipelines pass
    • black code-formatting passes (gitlab-ci),
    • test suite passes (gitlab-ci),
    • no degradation in code-coverage (codacy),
    • no (serious) new pylint code quality issues introduced (codacy),
    • documentation builds successfully (CI and readthedocs),
    • windows tests pass (manually triggered by maintainers before merging).

For reference, the issues workflow is described in the contribution guidelines.

Edited by Victor Negîrneac

Merge request reports