This module is not maintained. Please use nbsphinx instead!
docs |
|
|---|---|
tests |
|
package |
|
implementations |
|
Welcome! Similarly to Oscar Najeras sphinx-gallery module, this module intends to create an example gallery for your documentation. However, we don’t use python scripts, instead we create the example gallery out of a bunch of jupyter notebooks using nbconvert.
This package can be used to
Put all the examples you prepared in different notebooks in an pictured gallery
use the same html (sphinx) scheme for your examples that you are using for your documentation
Include the example notebooks in an offline (pdf) documentation
Include not only the code, but also the link to required supplementary files
Include a link to the Jupyter nbviewer
Installation
Simply install it via pip:
$ pip install sphinx-nbexamples
Or you install it via:
$ python setup.py install
from the source on GitHub.
Requirements
The package requires
Sphinx>=1.3: The python library for generating automated documentation
jupyter: The jupyter framework for jupyter notebooks. sphinx-nbexamples explicitly depends on
nbconvert: For converting jupyter notebooks to RST
jupyter_client: For managing the kernels
ipykernel: For installing an ipython kernel and run the notebooks
1 maintainer
Metadata
1 maintainer
Release files for sphinx-nbexamples 0.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinx-nbexamples-0.4.1.tar.gz | 961.8 kB | Without provenance | Details for sphinx-nbexamples-0.4.1.tar.gz |
Release files / sphinx-nbexamples-0.4.1.tar.gz
| Download URL | sphinx-nbexamples-0.4.1.tar.gz |
|---|---|
| Size | 961.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5de50d2ca1a21f3dc20d7b2d8a86ae02d8207a23c94f460ac700d79046bd0617
|
|
BLAKE2b-256 checksum How to use checksums |
cafea99c857f11cf3adc9a550ff6f7dfbd56da3e9842fa782d9ef34299d95c6b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/49.6.0.post20210108 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.6
|
Security for sphinx-nbexamples 0.4.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
