This release is a pre-release and may not be stable for production use.
mknotebooks
mknotebooks is a plugin for MkDocs, which makes it more convenient to include Jupyter notebooks in your project documentation.
Install
pip3 install mknotebooks
Usage
Simply include any notebooks you want to use in the docs source directory, and add mknotebooks to the plugin section of your mkdocs.yml as follows:
plugins:
- mknotebooks
You can optionally execute the notebooks, by setting execute: true in the config, and include a hidden preamble script, to be run before executing any cells using preamble: "<path/to/your/script>". The default cell execution timeout can be overridden by setting timeout: <timeout>, where <timeout> is an integer number of seconds.
By default, execution will be aborted if any of the cells throws an error, but you can set allow_errors: true to continue execution and include the error message in the cell output.
Any static images, plots, etc. will be extracted from the notebook and placed alongside the output HTML.
Styling
Mknotebooks applies default styling to improve the appearance of notebook input/output cells and pandas dataframes. If these interfere with any other CSS stylesheets that you're using, you can disable these via the following options.
# mkdocs.yml
- mknotebooks:
enable_default_jupyter_cell_styling: false
enable_default_pandas_dataframe_styling: false
Syntax hightlightting
In order to enable syntax highlighting for code blocks, pygments has to be installed and codehilite extension has to be enabled in mkdocs.yml.
- Install pygments:
pip install Pygments
- Enable
codehiliteextension inmkdocs.yml:
markdown_extensions:
- codehilite
Binder
You can also choose to have mknotebooks insert a Binder link into each notebook.
- mknotebooks:
binder: true
binder_service_name: "gh"
binder_branch: "master"
binder_ui: "lab"
If you are using GitLab, you will need to set binder_service_name to "gl".
Examples
Example docs projects demonstrating the use of a preamble and Binder are. Try them out by running pipenv install && pipenv run mkdocs serve.
Inspecting generated markdown
You can also export the generated markdown by setting write_markdown: true in your mkdocs.yml. This will write the generated markdown to a .md.tmp file alongside the original notebook.
1 maintainer
Metadata
1 maintainer
Release files for mknotebooks 0.7.0.post0.dev188
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mknotebooks-0.7.0.post0.dev188-py3-none-any.whl | Python 3 | none | any | Details |
Release files / mknotebooks-0.7.0.post0.dev188-py3-none-any.whl
| Download URL | mknotebooks-0.7.0.post0.dev188-py3-none-any.whl |
|---|---|
| Size | 13.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
01f674478fc07c58d4eb2852bd9f16cbbd86837f6e64ed64b0c078bf4e0c5c68
|
|
BLAKE2b-256 checksum How to use checksums |
be01b2253a0de75b5083598fdea3c743b69c8e719d029ff9dcdb06f87326f269
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.7.10
|
