Skip to content

Make the table of contents collapsed by default #2364

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

Merged
AA-Turner merged 5 commits into from
Mar 14, 2022
Merged

Make the table of contents collapsed by default #2364

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a6a5187
Fix links in section headings
AA-Turner Jan 29, 2022
8af9bf1
Remove automatic table of contents
AA-Turner Jan 29, 2022
92f3dc5
Revert "Remove automatic table of contents"
AA-Turner Mar 13, 2022
67355b2
Toggleable ToC
AA-Turner Mar 13, 2022
5f5f2a7
Fix rule
AA-Turner Mar 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Remove automatic table of contents
  • Loading branch information
@AA-Turner
AA-Turner committed Mar 13, 2022
commit 8af9bf1dadfe5212b79c52a05fa7184831514d36
4 changes: 2 additions & 2 deletions pep_sphinx_extensions/pep_processor/parsing/pep_parser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

from sphinx import parsers

from pep_sphinx_extensions.pep_processor.transforms import pep_contents
from pep_sphinx_extensions.pep_processor.transforms import pep_section_linker
from pep_sphinx_extensions.pep_processor.transforms import pep_footer
from pep_sphinx_extensions.pep_processor.transforms import pep_headers
from pep_sphinx_extensions.pep_processor.transforms import pep_title
Expand All @@ -27,6 +27,6 @@ def get_transforms(self) -> list[type[transforms.Transform]]:
return [
pep_headers.PEPHeaders,
pep_title.PEPTitle,
pep_contents.PEPContents,
pep_section_linker.PEPSectionLinker,
pep_footer.PEPFooter,
]
79 changes: 0 additions & 79 deletions pep_sphinx_extensions/pep_processor/transforms/pep_contents.py
View file
Open in desktop

This file was deleted.

30 changes: 30 additions & 0 deletions pep_sphinx_extensions/pep_processor/transforms/pep_section_linker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
from pathlib import Path

from docutils import nodes
from docutils import transforms


class PEPSectionLinker(transforms.Transform):
"""Link section headings to themselves."""

default_priority = 720

def apply(self) -> None:
if not Path(self.document["source"]).match("pep-*"):
return # not a PEP file, exit early
_link_section_headings(self.document[0][3:]) # skip PEP title, headers, and <hr/>


def _link_section_headings(children: list[nodes.Node]):
for section in children:
if not isinstance(section, nodes.section):
continue

# remove all pre-existing hyperlinks in the title (e.g. PEP references)
title = section[0]
while (link_node := title.next_node(nodes.reference)) is not None:
link_node.replace_self(link_node[0])

title["refid"] = section["ids"][0] # Add a link to self

_link_section_headings(section.children) # recurse to sub-sections
3 changes: 3 additions & 0 deletions pep_sphinx_extensions/pep_processor/transforms/pep_title.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ def apply(self) -> None:
pep_title_node.extend(document_children)
self.document.note_implicit_target(pep_title_node, pep_title_node)

# Add a horizontal rule after title and PEP headers
self.document[0].insert(2, nodes.transition())


def _line_to_nodes(text: str) -> list[nodes.Node]:
"""Parse RST string to nodes."""
Expand Down