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

fix missing entries in user guide's table of contents #221

Merged
merged 1 commit into from
Aug 18, 2023

Conversation

ianspektor
Copy link
Collaborator

@ianspektor ianspektor commented Aug 14, 2023

Using python comments inside a markdown cell messes with the table of contents, since it (buggily) interprets it as an H1 heading (which makes all the headers after this one hidden, since mkdocs expects a single H1 at the top of the file).

Solution is to either not use those comments (and pass that text to above/below the code cell if possible, or to use same-line comments, i.e. instead of this:

# This is a comment that messes up the ToC
<code>

do this

<code>  # This is a comment that doesn't mess up the ToC

note that this only applies to ``` code blocks inside markdown cells, comments inside code cells are fine.

Copy link
Collaborator

@DonBraulio DonBraulio left a comment

Choose a reason for hiding this comment

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

Ooh nice catch! I would've been ages to figure out this one 😅

@ianspektor ianspektor merged commit 8f4a1d1 into main Aug 18, 2023
14 checks passed
@ianspektor ianspektor deleted the fix-user-guide-toc branch August 18, 2023 09:02
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.

2 participants