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.

Sign up for GitHub

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

Jump to bottom

Add a toc for html and latex exporter #2178

Open
wants to merge 31 commits into
base: main
Choose a base branch
from
Open

Add a toc for html and latex exporter #2178

wants to merge 31 commits into from

Conversation

HaudinFlorence
Copy link

@HaudinFlorence HaudinFlorence commented Sep 16, 2024 •
edited
Loading

Add a toc for html and latex exporter.

This PR fixes #1690.

When working on this PR, an correlated issue was opened in jupyterlab jupyterlab/jupyterlab#16795

@HaudinFlorence HaudinFlorence force-pushed the add_exporter_for_html_toc branch 8 times, most recently from 322c26c to 6b3946a Compare September 17, 2024 14:17
@HaudinFlorence HaudinFlorence marked this pull request as ready for review September 17, 2024 14:17
@HaudinFlorence HaudinFlorence marked this pull request as draft September 17, 2024 14:38
@HaudinFlorence HaudinFlorence force-pushed the add_exporter_for_html_toc branch 7 times, most recently from 19fcd8c to 5f26a5c Compare September 19, 2024 13:29
@HaudinFlorence HaudinFlorence mentioned this pull request Sep 19, 2024
Closed
@martinRenou martinRenou self-requested a review October 4, 2024 09:20
martinRenou
martinRenou reviewed Oct 4, 2024
View reviewed changes
Copy link
Member

@martinRenou martinRenou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Neat! I don't have much to say, it looks good to me. I just have a tiny nitpicky comment about the CLI usage

@HaudinFlorence HaudinFlorence marked this pull request as ready for review October 4, 2024 12:27
@martinRenou martinRenou added enhancement format:LaTeX pertains to exporting to the LaTeX format format:HTML pertains to exporting to the HTML format labels Oct 4, 2024
@HaudinFlorence HaudinFlorence force-pushed the add_exporter_for_html_toc branch 5 times, most recently from 6293af2 to 4776c2a Compare October 4, 2024 15:50
HaudinFlorence and others added 25 commits February 3, 2025 10:13
@HaudinFlorence
Add links to be able to go to the relevant sections when clicking on …
1c7427a 
…the items of the table of contents.
@HaudinFlorence
Place the css inline in index.html.j2.
c86d451
@HaudinFlorence
Remove index.css from the git index.
c23d1eb
@HaudinFlorence
Add the include_tableofcontents traitlet and update the jinja templat…
8780c56 
…e accordingly.
@HaudinFlorence
Add the logics to include a table of contents for the latex exporter.
3bdca36
@HaudinFlorence
Update nbconvertapp with removing toc from alias and with adding toc …
b318e57 
…to nbconvert_flags dictionary instead.
@HaudinFlorence
Try to fix failing CI tests.
7d4b572
@HaudinFlorence
Try to fix pre-commit test.
28913c9
@HaudinFlorence
Try to fix failing linting test.
a804318
@HaudinFlorence
Update markdown.mistune.py and add docstrings to get 100% as a score …
c70f4fc 
…when running interrogate.
@pre-commit-ci @HaudinFlorence
[pre-commit.ci] auto fixes from pre-commit.com hooks
f175d45 
for more information, see https://pre-commit.ci
@HaudinFlorence @martinRenou
Apply suggestions from code review
3b4bc4d 
Co-authored-by: martinRenou <[email protected]>
@HaudinFlorence
Apply other suggestions from code review.
36e8889
@HaudinFlorence
Fix linting issues.
efc0133
@HaudinFlorence
Try to fix failing linting test.
7eeac98
@HaudinFlorence
Try to remove None check condition.
9554b7e
@HaudinFlorence
Restore None check condition in HTML exporter instead of _init_resources
df17ef2 
Fix index.html.j2 to restore the style of the table of content.
@HaudinFlorence
Change method extract_titles_from_markdown_input to extract_titles_fr…
e6f9d9e 
…om_notebook_node, include it in the resources dictionary and use it directly in the index.html.j2 template.
@HaudinFlorence
Update extract_titles_from_notebook_node to fix some parsing issues.
c03c701
@HaudinFlorence
Try to fix failing tests.
093b120
@HaudinFlorence
Remove condition on headers of level 1.
338f071
@HaudinFlorence
Update extract_titles_from_notebook_node.
5803af7
@HaudinFlorence
Change the logics to get the headers using parsing of the markdown ce…
d9ffc0c 
…ll content to html and using BeautifulSoup.select.
@HaudinFlorence
Add sysmetically an id to the headers to be sure to have a defined href.
3211755 
Add the safe filter in the jinja template.
@pre-commit-ci @HaudinFlorence
[pre-commit.ci] auto fixes from pre-commit.com hooks
3b45be0 
for more information, see https://pre-commit.ci
@HaudinFlorence HaudinFlorence force-pushed the add_exporter_for_html_toc branch 2 times, most recently from 0e337a6 to 3b45be0 Compare February 3, 2025 09:28
@HaudinFlorence HaudinFlorence force-pushed the add_exporter_for_html_toc branch from a233d15 to 6080520 Compare February 3, 2025 09:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@martinRenou martinRenou martinRenou requested changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
enhancement format:HTML pertains to exporting to the HTML format format:LaTeX pertains to exporting to the LaTeX format
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

command line argument for table of content.
2 participants
@HaudinFlorence @martinRenou