nbsphinx 0.9.3

Jupyter Notebook Tools for Sphinx

08-10-2021 210 words One minute 0 views

Contents

Jupyter Notebook Tools for Sphinx

Stars: 437, Watchers: 437, Forks: 130, Open Issues: 111

The spatialaudio/nbsphinx repo was created 8 years ago and the last code push was 3 days ago.
The project is popular with 437 github stars!

How to Install nbsphinx

You can install nbsphinx using pip

pip install nbsphinx

or add it to a project with poetry

poetry add nbsphinx

Package Details

Author: Matthias Geier
License: MIT
Homepage: https://nbsphinx.readthedocs.io/
PyPi:: https://pypi.org/project/nbsphinx/
Documentation:: https://nbsphinx.readthedocs.io/
GitHub Repo:: https://github.com/spatialaudio/nbsphinx

Classifiers

Documentation/Sphinx

No nbsphinx pypi packages just yet.

Errors

A list of common nbsphinx errors.

Code Examples

Here are some nbsphinx code examples and snippets.

GitHub Issues

The nbsphinx package has 111 open issues on GitHub

DOC: add example with rich content within Output widget
Update explanation regarding Raw cells
Support .jp-RenderedHTMLCommon CSS class
Add to documentation of how to add raw cells with ReST in JupyterLab
Underscore in the image alt markdown fails on RTD
CI: add Github action for building HTML on macOS
CI: Move to Github Actions
Allow using alternative markdown renderers
[WIP] allow toggling inputs and outputs
DOC: How to define LaTeX macros
Add options for inputs, outputs and prompts to be excluded
Added the hide_input option

See more issues on GitHub

Related Packages & Articles

nbconvert 7.16.3

Converting Jupyter Notebooks (.ipynb files) to other formats. Output formats include asciidoc, html, latex, markdown, pdf, py, rst, script. nbconvert can be used both as a Python library (import nbconvert) or as a command line tool (invoked as jupyter nbconvert ...).