diff options
| author | pennae <github@quasiparticle.net> | 2023-06-21 16:20:46 +0200 |
|---|---|---|
| committer | pennae <github@quasiparticle.net> | 2023-07-01 17:31:29 +0200 |
| commit | effbaf0ab40a06d547a42ec50073aa500d4bbbd5 (patch) | |
| tree | 1b0673c693972713a8acfd446417a53a52a7ea2a /pkgs/tools/nix/nixos-render-docs | |
| parent | 8c33134465ee45d2a2d9a060fe0da6c1232e9a1b (diff) | |
| download | nixpkgs-effbaf0ab40a06d547a42ec50073aa500d4bbbd5.tar nixpkgs-effbaf0ab40a06d547a42ec50073aa500d4bbbd5.tar.gz nixpkgs-effbaf0ab40a06d547a42ec50073aa500d4bbbd5.tar.bz2 nixpkgs-effbaf0ab40a06d547a42ec50073aa500d4bbbd5.tar.lz nixpkgs-effbaf0ab40a06d547a42ec50073aa500d4bbbd5.tar.xz nixpkgs-effbaf0ab40a06d547a42ec50073aa500d4bbbd5.tar.zst nixpkgs-effbaf0ab40a06d547a42ec50073aa500d4bbbd5.zip | |
nixos-render-docs: maybe omit link target files
docbook always emits intra-file links if only a single file is emitted. it doesn't seem to do this for intra-file links when multiple files are emitted, so we don't do that yet either.
Diffstat (limited to 'pkgs/tools/nix/nixos-render-docs')
| -rw-r--r-- | pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/manual.py | 18 | ||||
| -rw-r--r-- | pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/manual_structure.py | 5 |
2 files changed, 21 insertions, 2 deletions
diff --git a/pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/manual.py b/pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/manual.py index ef81e4d7e1a..138069d9820 100644 --- a/pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/manual.py +++ b/pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/manual.py @@ -312,7 +312,7 @@ class ManualHTMLRenderer(RendererMixin, HTMLRenderer): "".join((f'<script src="{html.escape(script, True)}" type="text/javascript"></script>' for script in self._html_params.scripts)), f' <meta name="generator" content="{html.escape(self._html_params.generator, True)}" />', - f' <link rel="home" href="{home.target.href()}" title="{home.target.title}" />', + f' <link rel="home" href="{home.target.href()}" title="{home.target.title}" />' if home.target.href() else "", f' {up_link}{prev_link}{next_link}', ' </head>', ' <body>', @@ -629,6 +629,22 @@ class HTMLConverter(BaseConverter[ManualHTMLRenderer]): failed = True # do another round and report the first error xref_queue = deferred + paths_seen = set() + for t in self._xref_targets.values(): + paths_seen.add(t.path) + + if len(paths_seen) == 1: + for (k, t) in self._xref_targets.items(): + self._xref_targets[k] = XrefTarget( + t.id, + t.title_html, + t.toc_html, + t.title, + t.path, + t.drop_fragment, + drop_target=True + ) + TocEntry.collect_and_link(self._xref_targets, tokens) diff --git a/pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/manual_structure.py b/pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/manual_structure.py index 95e6e9474e7..fcc3f02f19a 100644 --- a/pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/manual_structure.py +++ b/pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/manual_structure.py @@ -110,9 +110,12 @@ class XrefTarget: path: str """whether to drop the `#anchor` from links when expanding xrefs""" drop_fragment: bool = False + """whether to drop the `path.html` from links when expanding xrefs. + mostly useful for docbook compatibility""" + drop_target: bool = False def href(self) -> str: - path = html.escape(self.path, True) + path = "" if self.drop_target else html.escape(self.path, True) return path if self.drop_fragment else f"{path}#{html.escape(self.id, True)}" @dc.dataclass |