Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Sections not included in toctree when in first toc item

See original GitHub issue

Describe the bug If there are sections under the first toc item file, they are not included in the toctree.

To Reproduce Steps to reproduce the behavior:

jupyter-book create test
Move the first line in _toc.yml, - file: intro to bottom of file.
jupyter-book build test/.
Observe warnings written below in the console output.
Open build in webbrowser and see that the sections “Markdown files” and “Content with notebooks” under “Content in Jupyter Book” is not accessible on the website.

Expected behavior Expected behavior is that the sections “Markdown files” and “Content with notebooks” still are accessible on the website, even when it is the first item.

Console output

$ jupyter-book build test/
[...]
WARNING: Found a content page that is not in _toc.yml: markdown.md.     
WARNING: Found a content page that is not in _toc.yml: notebooks.ipynb.     
looking for now-outdated files... none found                
pickling environment... done                 
checking consistency... /home/jbtocsectiontest/test/markdown.md: WARNING: document isn't 
included in any toctree          
/home/jbtocsectiontest/test/notebooks.ipynb: WARNING: document isn't included in any toctree  
done    
[...]

Environment:

Python Version: 3.6.9
Package Version: 0.7.0b3

Issue Analytics

State:
Created 3 years ago
Comments:5 (3 by maintainers)

Top GitHub Comments

1reaction

choldgrafcommented, Jun 4, 2020

ah ha - you’ve actually found a bug! should be fixed here: https://github.com/executablebooks/jupyter-book/pull/696

thanks for noticing and opening the issue!

0reactions

mahoyencommented, Jun 4, 2020

I have pushed the test repository that I used to recreate the bug here: https://github.com/mahoyen/tocsections

Top Results From Across the Web

WARNING: document isn't included in any toctree for included ...

AFAIK, every .rst file that is not explicitly included in a toctree is regarded as "stray" by Sphinx and a warning message is...

The TOC tree — Sphinx 1.2 (hg) documentation

The toctree directive is the central element. Note. Simple “inclusion” of one file in another can be done with the include directive. .....

Directives - Sphinx documentation

The toctree directive is the central element. Note. Simple “inclusion” of one file in another can be done with the include directive. Note....

More on Toctrees — PFC 6.0 documentation

Both will cause the toctree to be “hidden”, which is to say, NOT rendered ... this section. .. toctree:: item1 This item describes...

toctree - reStructuredText and Sphinx Reference

Many, but not all, Sphinx themes show global table of contents in left sidebar ... For example, file element/toctree.rst is document name element/toctree...