-
Notifications
You must be signed in to change notification settings - Fork 663
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
[ENH] A simple {tableofcontents} directive #553
Conversation
Possible second phase features :-
|
@AakashGfude is this ready to go? (maybe try rebasing on master to see if the tests pass afterward? or fix those tests if we're ready to merge) |
@choldgraf do the functionalities look good enough to be merged for now? If yes, then I will take out some time, and correct the tests and also push the styles in |
I think it's a good first step! Let's get it merged and try it out to see how it feels |
dd26e7c
to
1ebf824
Compare
@choldgraf do you know why the test https://circleci.com/gh/executablebooks/jupyter-book/303?utm_campaign=vcs-integration-link&utm_medium=referral&utm_source=github-build-link is failing? |
I think the problem could be that you created a module for the directive but you didn’t add an init.py file |
f7c44ae
to
146d7c9
Compare
Thanks @choldgraf . The tests seem to be passing now. |
oops wait a sec - I just realized you didn't add any tests...can you please add a test to make sure that the structure is what we'd expect? I think just a simple pytest-regressions check should be fine. |
@choldgraf hmm. for the toctree directive though, I will need a project with |
13708fb
to
3b27f52
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good! A few quick comments
re-check the |
7013750
to
7402d53
Compare
@choldgraf have done the necessary changes. Let me know what you think |
7402d53
to
4f20e3e
Compare
c4d3bb5
to
c3e2c73
Compare
it looks great - let's give it a merge and see how the functionality feels! thanks @AakashGfude 🎉 |
Have transferred the PR here from MyST-NB executablebooks/MyST-NB#167 along with a few implementations of suggestions by @choldgraf
Syntax :-
At present it lays out the sub pages of the page where it is declared. I think we might also want it to have internal section links of the page as bullet points. Is that what you meant as well with your suggestion @choldgraf here - executablebooks/MyST-NB#167? or just the external sub-pages.
Adding it in the
intro.md
page gives :-Adding it to /content-types/index.md page gives :-