A sphinx extension for including notebook files from outside the sphinx source root.
Normally, Sphinx will only allow you to add files that are situated inside the source directory, but you might want to include files from another directory, for example a central ‘examples’ folder. For RST files these can be linked with include directives inside another RST file. For notebooks, there’s nbsphinx-link!
Usage
Install the package.
Add ‘nbsphinx_link’ to extensions in Sphinx config ‘conf.py’
Add a file with the ‘.nblink’ extension where you want them included.
The .nblink file is a JSON file with the following structure:
{
"path": "relative/path/to/notebook"
}
Optionally the “extra-media” key can be added, if your notebook includes any media, i.e. images. The value needs to be an array of strings, which are paths to the media files or directories to include. Note that this is not needed if the images are added as attachments to markdown cells.
Further keys might be added in the future.
Note that the documentation of this project might serve as a further resource!
1 maintainer
Release files for nbsphinx-link 1.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 | |
|---|---|---|---|
| nbsphinx_link-1.4.1.tar.gz | 17.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| nbsphinx_link-1.4.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 23.5 kB
Release files / nbsphinx_link-1.4.1.tar.gz
| Download URL | nbsphinx_link-1.4.1.tar.gz |
|---|---|
| Size | 17.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
566d5640c165627dc3ae8442a9424ae89cc4af9794261737d8b16bb6717597b8
|
|
BLAKE2b-256 checksum How to use checksums |
ff1ae38d8c65034ba12fce5d2579fd42ce8a8be3a766c03c49b24cd525e9a99c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.0
|
Release files / nbsphinx_link-1.4.1-py3-none-any.whl
| Download URL | nbsphinx_link-1.4.1-py3-none-any.whl |
|---|---|
| Size | 5.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9f5554b844b0f2c4098f5886e331ffea4999e13d13b846235c1bcb4efc9d9b54
|
|
BLAKE2b-256 checksum How to use checksums |
03ad4f4aa68f8e9566187e9e3ff1677fc2a02364baa3007deb38a1704010b32e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.0
|
