Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ NEW: Create ToC from file structure #14

Merged
merged 3 commits into from
Apr 8, 2021
Merged

Conversation

chrisjsewell
Copy link
Member

@chrisjsewell chrisjsewell commented Apr 8, 2021

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

  • configurable index name and suffixes
  • using "natural sort order" for files/folders
  • using fnmatch for matching files/folders to skip
  • better testing

@codecov
Copy link

codecov bot commented Apr 8, 2021

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%) ⬆️

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%) ⬆️
sphinx_external_toc/tools.py 91.48% <91.80%> (+0.06%) ⬆️
sphinx_external_toc/cli.py 95.12% <95.65%> (+0.12%) ⬆️

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant