Questions tagged [nbsphinx]

nbsphinx is a Sphinx extension that provides a source parser for *.ipynb (Jupyter Notebook) files.

nbsphinx is a extension that provides a source parser for *.ipynb () files.

See https://nbsphinx.readthedocs.io.

8 questions
2
votes
1 answer

Read the Docs with nbsphinx

I created my own docs for Read the Docs. See my repository Some of my docs files are jupyter notebook so I used nbshpinx for it. In my computer I installed all the dependencies and it works great when I use make html. However, Read the docs throws…
J Agustin Barrachina
  • 3,501
  • 1
  • 32
  • 52
1
vote
1 answer

How to use admonitions in nbsphinx?

I'm currently using the jupyter-sphinx extention in my documentation to execute code. I'm dealing at the same time with Google services authentication which have proven to be dificult using this extention. I tested it with nbsphinx which have proven…
Pierrick Rambaud
  • 1,726
  • 1
  • 20
  • 47
0
votes
0 answers

Sphinx roles and directives do not work in notebooks text blocks

I am creating documentation for a project using sphinx with a set of examples I am running with sphinx-gallery, however in the resulting html files, sphinx roles and directives (e.g. :class:, :meth:, :attr:, :footcite:) do not generate properly.…
0
votes
1 answer

How to enable syntax highlighting when using nbsphinx with confluencebuilder?

When I publish the docs of a project using confluencebuilder, the part of the documentation which was generated by nbsphinx (comprising a few tutorial notebooks) does not display synthax highlighting. I had a similar problem when publishing in…
LuizFelippe
  • 172
  • 9
0
votes
0 answers

Including notebook in sphinx documentation

I am trying to include notebook in sphinx documentation. I installed nbsphinx. But when I do make html, the following error appears make html Running Sphinx v5.3.0 Extension error: Could not import extension nbsphinx (exception: cannot import name…
Natasha
  • 1,111
  • 5
  • 28
  • 66
0
votes
0 answers

How to use notebook path in the nbsphinx?

I am trying to render a notebook for the documentation. I am currently using nbsphinx. Folder structure is : - Temp - source - conf.py - index.rst - Data.ipynb Content of conf.py is: project = 'temp' copyright =…
Pawan bisht
  • 183
  • 1
  • 9
0
votes
0 answers

Get 'make html' to process jupyter notebooks with markdown instead of with restructuredtext

The github repo on which I work with many others contains many python files and about ten jupyter notebooks. 'make html' currently assumes that the markdown JN cells are written in reST, which can produce meaningless and ugly results. Is it possible…
0
votes
1 answer

Storing Jupyter notebook "orphan" metadata in percent format scripts

I've got a Jupyter notebook in percent format that I'd like to add the nbsphinx orphan property to. Is this possible? So far, I've tried: Editing the metadata in the UI and saving (doesn't update the script) Saving it as a .ipynb, editing the…
Uri Granta
  • 1,814
  • 14
  • 25