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
33 stars 18 forks source link

✨ NEW: Create ToC from file structure #14

Closed chrisjsewell closed 3 years ago

chrisjsewell commented 3 years ago

This is a re-working of jupyter-book toc (by @choldgraf) but with improvements such as:

codecov[bot] commented 3 years ago

Codecov Report

Merging #14 (39d9ed2) into main (6fdc3af) will increase coverage by 0.50%. The diff coverage is 91.95%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #14      +/-   ##
==========================================
+ Coverage   89.81%   90.32%   +0.50%     
==========================================
  Files           5        5              
  Lines         383      465      +82     
==========================================
+ Hits          344      420      +76     
- Misses         39       45       +6     
Flag Coverage Δ
pytests 90.32% <91.95%> (+0.50%) :arrow_up:

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

Impacted Files Coverage Δ
sphinx_external_toc/api.py 89.26% <66.66%> (+0.12%) :arrow_up:
sphinx_external_toc/tools.py 91.48% <91.80%> (+0.06%) :arrow_up:
sphinx_external_toc/cli.py 95.12% <95.65%> (+0.12%) :arrow_up:

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 6fdc3af...39d9ed2. Read the comment docs.