Questions tagged [jupyterbook]

33 questions
5
votes
3 answers

Referring to sub-section in a markdown file in another folder

Related to Markdown: Reference to section from another file I have two markdown files: ├── parent.md └── content/ └── child.md In parent.md: # Main section ## sub-section I'd like to make a reference to ##sub-section from child.md. How do I do…
user308827
  • 21,227
  • 87
  • 254
  • 417
4
votes
0 answers

How do I reference a relative path in Jupyter-book

In Jupyter-book, I am creating a _toc.yml file. I have something like - - caption: Tutorials chapters: - file: ../../notebooks/some_notebook I get the exception - home/code/nwb_datajoint/docs/web-doc/intro.md:: WARNING: toctree contains…
Phil
  • 2,143
  • 19
  • 44
4
votes
0 answers

Is it possible to set Sphinx autodoc module path from Jupyter Book?

Is it possible to set the Sphinx autodoc Python module path from Jupyter Book, for example via _config.yml? I'm using Jupyter Book to document a Python system and publish to Read The Docs. I can set the module path from Sphinx by adding code like…
3
votes
0 answers

In Sphinx, when using sphinx.ext.autosummary, how do I exclude base class members?

I am using Sphinx to document a code base docString; in python. I have code like this - class foo(np.ndarray): def foo_func(): pass class bar(foo): def bar_func(): pass When using sphinx.ext.autosummary to document the code…
Phil
  • 2,143
  • 19
  • 44
2
votes
1 answer

Jupyter book - Change Image Size in Jupyter notebook

I am creating a jupyterbook using jb build my_report --builder=pdflatex In my jupyter book, my output is written in the notebooks.ipynb. Within this report I have from IPython.display import Image Image(filename='Images/my_image.png',width=600,…
Anon.user111
  • 468
  • 1
  • 5
  • 16
1
vote
1 answer

How to hide Intro/Index Page in TOC of Jupyterbook?

The Documentation of Jupyter Book is not showing the Intro/Index Page in the TOC on the left sidebar. That's what I want for my book. The Documentation does not explain how to do this. Does anyone know? Jupyterbook: Structure the Table of Content
1
vote
1 answer

How to activate auto header generation in jupyter-book?

In my jupyter-book, I want to reference a section header in the same document using the syntax below: I want to refer to [section](intro.md#how-to-learn-python] where intro.md is your current markdown file, and how-to-learn-python is a section…
ilovewt
  • 911
  • 2
  • 10
  • 18
1
vote
1 answer

How do I increase the resolution of Matplotlib plots in Jupyter Book?

I typically use plt.rcParams['figure.dpi'] = 300 to increase the resolution of Matplotlib plots in my Jupyter notebooks. However, this setting does not seem to work with Jupyter Books. Here are reproducible steps: Create a Jupyter Book template…
Richard Herron
  • 9,760
  • 12
  • 69
  • 116
1
vote
0 answers

Modifying content width of Jupyter book, or the Sphinx theme sphinx-book-theme

I am using jupyter-book which by default uses the sphinx-book-theme. There is a left sidebar, the content in the middle column and a right sidebar. I would like to make the content column wider. This was answered for the readthedocs-theme, but I'm…
James Hirschorn
  • 7,032
  • 5
  • 45
  • 53
1
vote
0 answers

How to speed up Jupyter book build

I have 115 notebooks that run the same logic on different data. One notebook takes on average 20 minutes to run. I'd like to use Jupyterbook to create a shareable/clean version of all the information together. Jupyterbook has currently been running…
user123328
  • 63
  • 1
  • 10
1
vote
0 answers

Jupyter book build error: No template sub-directory with name 'script' found in the following paths

I have seen the similar questions but they aren't answering the issue I'm having. Whenever I try to build my jupyter-book it returns this error: ValueError: No template sub-directory with name 'script' found in the following paths: …
1
vote
0 answers

`Jupyter-book build` taking too much RAM when building 4.5K notebooks

Background I have preprocessed over 4.5K jupyter notebooks. I would like to use jupyter-book to build a book from the processed notebooks. I have execute_notebooks: "off" in my jupyter-book configs. However, when I run jupyter-book build on the…
Avi Vajpeyi
  • 568
  • 6
  • 17
1
vote
1 answer

Impossible to run jupyter-book command after installing it

I'm trying to use Jupyter-book to create automatical PDF from my output, but after installing it using the 'pip install -U jupyter-book' command (which runs successfully), it doesn't recognize jupyter-book when I try to run a…
Skilmoule
  • 11
  • 1
1
vote
1 answer

jupyter book WARNING: document isn't included in any toctree

after processing (jupyter-book build) the TOC-navigation does not appear. My _toc.yml is - at least I think so - according to the Jupyter Book tutorial. The processing information tells: "WARNING: toctree contains reference to nonexisting…
pyano
  • 1,885
  • 10
  • 28
1
vote
0 answers

dtale show in jupyter book

I use jupyter book for creating books from jupyterlab notebooks. dtale tables do not show up in the jupyter book (they do show up in the jupyter notebook). I read that jupyterbook expects Interactive outputs will work under the assumption that the…
1
2 3