From 2bf3bb4f6b70a69d43c8c50eac735e1e95d16eb4 Mon Sep 17 00:00:00 2001 From: pennae Date: Wed, 21 Jun 2023 16:34:02 +0200 Subject: [PATCH] nixos-render-docs: hide nav headers/footers if not needed there's not point in rendering these if we're rendering to a single file for all content. --- .../src/nixos_render_docs/manual.py | 66 +++++++++++-------- 1 file changed, 38 insertions(+), 28 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 138069d98204..1f0e312c91e1 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 @@ -284,6 +284,7 @@ class ManualHTMLRenderer(RendererMixin, HTMLRenderer): def _file_header(self, toc: TocEntry) -> str: prev_link, up_link, next_link = "", "", "" prev_a, next_a, parent_title = "", "", " " + nav_html = "" home = toc.root if toc.prev: prev_link = f'' @@ -299,6 +300,22 @@ class ManualHTMLRenderer(RendererMixin, HTMLRenderer): if toc.next: next_link = f'' next_a = f'Next' + if toc.prev or toc.parent or toc.next: + nav_html = "\n".join([ + '
', + ' ', + ' ', + f' ', + ' ', + ' ', + f' ', + f' ', + f' ', + ' ', + '
{toc.target.title}
{prev_a} {parent_title} {next_a}
', + '
', + '
', + ]) return "\n".join([ '', '', ' ', - '
', - ' ', - ' ', - f' ', - ' ', - ' ', - f' ', - f' ', - f' ', - ' ', - '
{toc.target.title}
{prev_a} {parent_title} {next_a}
', - '
', - '
', + nav_html, ]) def _file_footer(self, toc: TocEntry) -> str: # prev, next = self._get_prev_and_next() prev_a, up_a, home_a, next_a = "", " ", " ", "" prev_text, up_text, next_text = "", "", "" + nav_html = "" home = toc.root if toc.prev: prev_a = f'Prev' @@ -348,22 +354,26 @@ class ManualHTMLRenderer(RendererMixin, HTMLRenderer): next_a = f'Next' assert toc.next.target.title next_text = toc.next.target.title + if toc.prev or toc.parent or toc.next: + nav_html = "\n".join([ + '
', + '
', + ' ', + ' ', + f' ', + f' ', + f' ', + ' ', + ' ', + f' ', + f' ', + f' ', + ' ', + '
{prev_a} {up_a} {next_a}
{prev_text} {home_a} {next_text}
', + '
', + ]) return "\n".join([ - '
', - '
', - ' ', - ' ', - f' ', - f' ', - f' ', - ' ', - ' ', - f' ', - f' ', - f' ', - ' ', - '
{prev_a} {up_a} {next_a}
{prev_text} {home_a} {next_text}
', - '
', + nav_html, ' ', '', ])