NBSPHINX VERSION 0.9.7-1-G025B46B

Navigation

nbsphinx version 0.9.7-1-g025b46b>
Index

>

Table of Contents

Installation
- nbsphinx Packages
- nbsphinx Prerequisites
Usage
- Project Setup
- Running Sphinx
- Watching for Changes with sphinx-autobuild
- Automatic Creation of HTML and PDF output on readthedocs.org
  - Using requirements.txt
  - Using conda
- Automatic Creation of HTML and PDF output on GitLab Pages
- HTML Themes
  - Sphinx’s Built-In Themes
  - 3rd-Party Themes
- Using Notebooks with Git
Configuration
- Sphinx Configuration Values
- nbsphinx Configuration Values
Markdown Cells
- Equations
  - Automatic Equation Numbering
  - Manual Equation Numbering
- Citations
  - Footnote citations
- Code
- Tables
- Images
  - Using the HTML <img> tag
  - SVG support for LaTeX
- Cell Attachments
- HTML Elements (HTML only)
- Info/Warning Boxes
- Links to Other Notebooks
- Links to *.rst Files (and Other Sphinx Source Files)
- Links to Local Files
- Links to Domain Objects
Code Cells
- Code, Output, Streams
- Special Display Formats
- ANSI Colors
Raw Cells
- Usage
  - Jupyter Notebook
  - JupyterLab
- Available Raw Cell Formats
  - None
  - reST
  - Markdown
  - HTML
  - LaTeX
  - Python
Hidden Cells
Controlling Notebook Execution
- Pre-Executing Notebooks
- Explicitly Dis-/Enabling Notebook Execution
- Ignoring Errors
- Ignoring Errors on a Per-Cell Basis
- Configuring Kernels
- Cell Execution Timeout
Prolog and Epilog
- Examples
Custom Notebook Formats
- Example: Jupytext
Notebooks in Sub-Directories
- A Sub-Section
- That’s a “Strange” Section
Creating Thumbnail Galleries
- Gallery With Nested Documents
- Gallery With Links (HTML only)
Using toctree In A Notebook
- A Notebook that's just a "toctree" Target
- An External Link (HTML only)
Custom CSS
- For All Pages
- For All RST files
- For All Notebooks
- For a Single Notebook
Normal reStructuredText Files
- Links to Notebooks (and Other Sphinx Source Files)
- Links to Notebooks, Ye Olde Way
- Sphinx Directives for Info/Warning Boxes
- Domain Objects
  - example_python_function()
- References
  - Citations
  - Footnote citations
- Thumbnail Link Galleries (HTML only)
- Thumbnail Galleries
  - Dummy Notebook 1 for Gallery
  - Dummy Notebook 2 for Gallery
Using Markdown Files
- Links to Notebooks (and Other Sphinx Source Files)
- Math
- Tables
- Images
External Links
Contributing
- Development Installation
- Building the Documentation
- Building Themes
- Testing
References
Version History

Index

B | E

B

built-in function
- example_python_function()

E

example_python_function()
- built-in function

Created using Sphinx 8.1.3.