mirror of
https://github.com/NixOS/nixpkgs.git
synced 2026-07-06 17:13:24 -05:00
pkgs/nixos-render-docs: remove dead {examples,figures} table
It is emited into the output but we set 'display: none
This commit is contained in:
parent
665fa9e6bc
commit
140264dc32
3 changed files with 8 additions and 27 deletions
|
|
@ -34,10 +34,6 @@ body {
|
|||
}
|
||||
}
|
||||
|
||||
.list-of-examples {
|
||||
display: none;
|
||||
}
|
||||
|
||||
h1 {
|
||||
font-size: 2em;
|
||||
margin: 0.67em 0;
|
||||
|
|
|
|||
|
|
@ -494,9 +494,7 @@ class ManualHTMLRenderer(RendererMixin, HTMLRenderer):
|
|||
'</div>'
|
||||
)
|
||||
nav = render_entries(root.children, self._html_params.sidebar_depth)
|
||||
figures = build_list("Figures", "list-of-figures", root.figures)
|
||||
examples = build_list("Examples", "list-of-examples", root.examples)
|
||||
return f'{nav}{figures}{examples}'
|
||||
return f'{nav}'
|
||||
|
||||
def _make_hN(self, level: int) -> tuple[str, str]:
|
||||
# book heading := h1
|
||||
|
|
|
|||
|
|
@ -3,13 +3,12 @@ from __future__ import annotations
|
|||
import dataclasses as dc
|
||||
import html
|
||||
import itertools
|
||||
|
||||
from typing import cast, get_args, Iterable, Literal, Sequence
|
||||
from typing import Iterable, Literal, Sequence, cast, get_args
|
||||
|
||||
from markdown_it.token import Token
|
||||
|
||||
from .utils import Freezeable
|
||||
from .src_error import SrcError
|
||||
from .utils import Freezeable
|
||||
|
||||
# FragmentType is used to restrict structural include blocks.
|
||||
FragmentType = Literal['preface', 'part', 'chapter', 'section', 'appendix']
|
||||
|
|
@ -146,8 +145,6 @@ class TocEntry(Freezeable):
|
|||
next: TocEntry | None = None
|
||||
children: list[TocEntry] = dc.field(default_factory=list)
|
||||
starts_new_chunk: bool = False
|
||||
examples: list[TocEntry] = dc.field(default_factory=list)
|
||||
figures: list[TocEntry] = dc.field(default_factory=list)
|
||||
|
||||
@property
|
||||
def root(self) -> TocEntry:
|
||||
|
|
@ -162,7 +159,7 @@ class TocEntry(Freezeable):
|
|||
|
||||
@classmethod
|
||||
def collect_and_link(cls, xrefs: dict[str, XrefTarget], tokens: Sequence[Token]) -> TocEntry:
|
||||
entries, examples, figures = cls._collect_entries(xrefs, tokens, 'book')
|
||||
entries = cls._collect_entries(xrefs, tokens, 'book')
|
||||
|
||||
def flatten_with_parent(this: TocEntry, parent: TocEntry | None) -> Iterable[TocEntry]:
|
||||
this.parent = parent
|
||||
|
|
@ -179,9 +176,6 @@ class TocEntry(Freezeable):
|
|||
prev = c
|
||||
paths_seen.add(c.target.path)
|
||||
|
||||
flat[0].examples = examples
|
||||
flat[0].figures = figures
|
||||
|
||||
for c in flat:
|
||||
c.freeze()
|
||||
|
||||
|
|
@ -189,37 +183,30 @@ class TocEntry(Freezeable):
|
|||
|
||||
@classmethod
|
||||
def _collect_entries(cls, xrefs: dict[str, XrefTarget], tokens: Sequence[Token],
|
||||
kind: TocEntryType) -> tuple[TocEntry, list[TocEntry], list[TocEntry]]:
|
||||
kind: TocEntryType) -> TocEntry:
|
||||
# we assume that check_structure has been run recursively over the entire input.
|
||||
# list contains (tag, entry) pairs that will collapse to a single entry for
|
||||
# the full sequence.
|
||||
entries: list[tuple[str, TocEntry]] = []
|
||||
examples: list[TocEntry] = []
|
||||
figures: list[TocEntry] = []
|
||||
for token in tokens:
|
||||
if token.type.startswith('included_') and (included := token.meta.get('included')):
|
||||
fragment_type_str = token.type[9:].removesuffix('s')
|
||||
assert fragment_type_str in get_args(TocEntryType)
|
||||
fragment_type = cast(TocEntryType, fragment_type_str)
|
||||
for fragment, _path in included:
|
||||
subentries, subexamples, subfigures = cls._collect_entries(xrefs, fragment, fragment_type)
|
||||
subentries = cls._collect_entries(xrefs, fragment, fragment_type)
|
||||
entries[-1][1].children.append(subentries)
|
||||
examples += subexamples
|
||||
figures += subfigures
|
||||
elif token.type == 'heading_open' and (id := cast(str, token.attrs.get('id', ''))):
|
||||
while len(entries) > 1 and entries[-1][0] >= token.tag:
|
||||
entries[-2][1].children.append(entries.pop()[1])
|
||||
entries.append((token.tag,
|
||||
TocEntry(kind if token.tag == 'h1' else 'section', xrefs[id])))
|
||||
token.meta['TocEntry'] = entries[-1][1]
|
||||
elif token.type == 'example_open' and (id := cast(str, token.attrs.get('id', ''))):
|
||||
examples.append(TocEntry('example', xrefs[id]))
|
||||
elif token.type == 'figure_open' and (id := cast(str, token.attrs.get('id', ''))):
|
||||
figures.append(TocEntry('figure', xrefs[id]))
|
||||
|
||||
|
||||
while len(entries) > 1:
|
||||
entries[-2][1].children.append(entries.pop()[1])
|
||||
return (entries[0][1], examples, figures)
|
||||
return entries[0][1]
|
||||
|
||||
_xml_id_translate_table = {
|
||||
ord('*'): ord('_'),
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue