nathan/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2026-08-25 17:55:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

pkgs/nixos-render-docs: fix included content should be 'page' to avoid class collisions

Browse Source
This commit is contained in:
Johannes Kirschbauer
2026-08-07 17:16:57 +02:00
parent 23b0cf7262
commit dd29ae4ccb
3 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
doc/style.css
View File

@@ -465,7 +465,8 @@ div.appendix .variablelist .term {
font-display: swap;
}
.chapter {
div.chapter,
div.page {
content-visibility: auto;
}

10
pkgs/by-name/ni/nixos-render-docs/src/nixos_render_docs/manual.py
View File

@@ -236,7 +236,7 @@ class RendererMixin(Renderer):
'included_preface': lambda *args: self._included_thing("preface", *args),
'included_parts': lambda *args: self._included_thing("part", *args),
'included_appendix': lambda *args: self._included_thing("appendix", *args),
'included_content': lambda *args: self._included_thing("content", *args),
'included_page': lambda *args: self._included_thing("page", *args),
'included_options': self.included_options,
}
@@ -396,7 +396,7 @@ class ManualHTMLRenderer(RendererMixin, HTMLRenderer):
intersection_observer_js = """
//<![CDATA[
function createObserver() {
const content = document.querySelector(".content");
const content = document.querySelector("main.content");
const headings = content.querySelectorAll("h1, h2, h3, h4, h5, h6");
const links = new Map();
@@ -739,7 +739,7 @@ class HTMLConverter(BaseConverter[ManualHTMLRenderer]):
def _build_config_include(self, nodes: list[ConfigNode], config_file: Path) -> Token:
included = [self._build_config_item(node, config_file) for node in nodes]
token = Token('included_content', '', 0, map=[0, 1])
token = Token('included_page', '', 0, map=[0, 1])
token.meta['included'] = included
token.meta['include-args'] = {}
return token
@@ -749,7 +749,7 @@ class HTMLConverter(BaseConverter[ManualHTMLRenderer]):
path = (config_file.parent / node.file).resolve()
leaf_src = path.read_text()
self._base_paths.append(path)
self._current_type.append('content')
self._current_type.append('page')
try:
fragment = self._parse(leaf_src)
finally:
@@ -884,7 +884,7 @@ class HTMLConverter(BaseConverter[ManualHTMLRenderer]):
title_html = (
f"<em>{title_html}</em>"
if typ == 'chapter'
else title_html if typ in [ 'book', 'part', 'content' ]
else title_html if typ in [ 'book', 'part', 'page' ]
else f'the section called “{title_html}”'
)
return XrefTarget(id, title_html, toc_html, re.sub('<.*?>', '', title), path, drop_fragment)

4
pkgs/by-name/ni/nixos-render-docs/src/nixos_render_docs/manual_structure.py
View File

@@ -15,8 +15,8 @@ FragmentType = Literal['preface', 'part', 'chapter', 'section', 'appendix']
# the TOC allows every fragment type. it also allows the enclosing book.
# it allows 'example' and 'figure'.
# --experimental-config adds a generic 'content' kind.
TocEntryType = Literal['book', 'preface', 'part', 'chapter', 'section', 'appendix', 'example', 'figure', 'content']
# --experimental-config adds a generic 'page' kind.
TocEntryType = Literal['book', 'preface', 'part', 'chapter', 'section', 'appendix', 'example', 'figure', 'page']
def is_include(token: Token) -> bool:
return token.type == "fence" and token.info.startswith("{=include=} ")