Add a toc for html and latex exporter #2178
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…markdown contents.
for more information, see https://pre-commit.ci
HaudinFlorence
force-pushed
the
add_exporter_for_html_toc
branch
3 times, most recently
from
20a8394
to
16166f0
Compare
HaudinFlorence
force-pushed
the
add_exporter_for_html_toc
branch
2 times, most recently
from
6bc676c
to
f7eb4c4
Compare
HaudinFlorence
force-pushed
the
add_exporter_for_html_toc
branch
3 times, most recently
from
322c26c
to
6b3946a
Compare
…the items of the table of contents.
HaudinFlorence
force-pushed
the
add_exporter_for_html_toc
branch
2 times, most recently
from
d16bad8
to
3fefaae
Compare
HaudinFlorence
force-pushed
the
add_exporter_for_html_toc
branch
from
e7678a3
to
04011ea
Compare
HaudinFlorence
force-pushed
the
add_exporter_for_html_toc
branch
2 times, most recently
from
2a3e213
to
5de2600
Compare
HaudinFlorence
force-pushed
the
add_exporter_for_html_toc
branch
from
469368e
to
05f6f11
Compare
HaudinFlorence
force-pushed
the
add_exporter_for_html_toc
branch
from
19fcd8c
to
5f26a5c
Compare
martinRenou
reviewed
Oct 4, 2024
martinRenou
reviewed
Oct 4, 2024
HaudinFlorence
force-pushed
the
add_exporter_for_html_toc
branch
3 times, most recently
from
8b6ea2c
to
5807458
Compare
…when running interrogate.
HaudinFlorence
force-pushed
the
add_exporter_for_html_toc
branch
2 times, most recently
from
e4cef00
to
cb90485
Compare
for more information, see https://pre-commit.ci
martinRenou
requested changes
Oct 7, 2024
nbconvert/exporters/html.py
Outdated
Comment on lines
269
to
273
| if resources is None: | ||
| resources = {} | ||
| resources.update( | ||
| {"tableofcontents": extract_titles_from_markdown_input(markdown_collection)} | ||
| ) |
There was a problem hiding this comment.
I feel like it would better having this in _init_resources as this is the place where we initialize the resources
There was a problem hiding this comment.
Thanks for the comment. This has been moved to _init_resources. But this is probably not inducing the proper checking on resources not being None since it is breaking again the linting CI test with this type of error
nbconvert/exporters/html.py:269: error: Item "None" of "Optional[Dict[str, Any]]" has no attribute "update" [union-attr]
There was a problem hiding this comment.
Instead of using update, you could follow what the rest of the code is doing: resources["tableofcontents"] = extract_titles_from_markdown_input(markdown_collection)
There was a problem hiding this comment.
This was initially what was used but without any check that resources was not None.
Introducing the suggested change leads to this error message
nbconvert/exporters/html.py:269: error: Unsupported target for indexed assignment ("Optional[Dict[str, Any]]") [index]
nbconvert/exporters/html.py:358: error: Name "resources" already defined on line 294 [no-redef]
Maybe the type check in the _init_resources function is not valid.
There was a problem hiding this comment.
I have displaced the None check condition back at its initial place, in the HTMLExporter
Co-authored-by: martinRenou <[email protected]>
HaudinFlorence
force-pushed
the
add_exporter_for_html_toc
branch
3 times, most recently
from
5e3d85e
to
248ddff
Compare
HaudinFlorence
force-pushed
the
add_exporter_for_html_toc
branch
from
5ce9a04
to
c8483f8
Compare
HaudinFlorence
force-pushed
the
add_exporter_for_html_toc
branch
from
0238fb3
to
711cee8
Compare
Fix index.html.j2 to restore the style of the table of content.
HaudinFlorence
force-pushed
the
add_exporter_for_html_toc
branch
from
320d056
to
cdc2743
Compare
HaudinFlorence
changed the title
…om_notebook_node, include it in the resources dictionary and use it directly in the index.html.j2 template.
HaudinFlorence
force-pushed
the
add_exporter_for_html_toc
branch
2 times, most recently
from
9452783
to
de2ff4e
Compare
HaudinFlorence
force-pushed
the
add_exporter_for_html_toc
branch
from
2117401
to
6fbb968
Compare
HaudinFlorence
force-pushed
the
add_exporter_for_html_toc
branch
from
c799885
to
5708233
Compare
for more information, see https://pre-commit.ci
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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