search

executablebooks / sphinx-external-toc

A sphinx extension that allows the site-map to be defined in a single YAML file
https://sphinx-external-toc.readthedocs.io
MIT License
34 stars 18 forks source link

🐛 FIX: Inserting toctree into empty document #77

Closed chrisjsewell closed 2 years ago

chrisjsewell commented 2 years ago

closes #54

It is interesting to note, that if you insert a toctree under a section, you get the expected behaviour of:

image

But, if the document does not have a heading, and so you insert as a direct child of the document. You get:

image

i.e. you can "hide" the index page

Not sure if this is specific to sphinx-book-theme and/or an expected feature of sphinx

codecov[bot] commented 2 years ago

Codecov Report

Merging #77 (c8a6655) into main (3d18fee) will decrease coverage by 0.11%. The diff coverage is 66.66%.

@@            Coverage Diff             @@
##             main      #77      +/-   ##
==========================================
- Coverage   90.95%   90.84%   -0.12%     
==========================================
  Files           7        7              
  Lines         730      732       +2     
==========================================
+ Hits          664      665       +1     
- Misses         66       67       +1
Flag Coverage Δ
pytests 90.84% <66.66%> (-0.12%) :arrow_down:

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
sphinx_external_toc/events.py 89.63% <50.00%> (-0.49%) :arrow_down:
sphinx_external_toc/api.py 94.05% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 3d18fee...c8a6655. Read the comment docs.