about summary refs log tree commit diff
path: root/pkgs/tools/nix/nixos-render-docs
diff options
context:
space:
mode:
authorViktor Kronvall <viktor.kronvall@gmail.com>2023-11-26 00:39:19 +0900
committergithub-actions[bot] <github-actions[bot]@users.noreply.github.com>2023-11-26 18:35:55 +0000
commit56c455509a0c8787b3eb83798ee211c39ce0c484 (patch)
tree5f1b73403168bd3bde3c9e67d1afa9f0921dd77b /pkgs/tools/nix/nixos-render-docs
parent1accd93ecaef1ca6fe92916ccd275ae7dc1010c5 (diff)
nixos-render-docs: header and footer as list[str]
(cherry picked from commit 98ba0aed731dbcb0f1facd29bb9398630adaa141)
Diffstat (limited to 'pkgs/tools/nix/nixos-render-docs')
-rw-r--r--pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/options.py25
1 files changed, 17 insertions, 8 deletions
diff --git a/pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/options.py b/pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/options.py
index 734339c0df647..d0229e074c543 100644
--- a/pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/options.py
+++ b/pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/options.py
@@ -288,8 +288,8 @@ class ManpageConverter(BaseConverter[OptionsManpageRenderer]):
     _links_in_last_description: Optional[list[str]] = None
 
     def __init__(self, revision: str,
-                 header: Path | None,
-                 footer: Path | None,
+                 header: list[str] | None,
+                 footer: list[str] | None,
                  *,
                  # only for parallel rendering
                  _options_by_id: Optional[dict[str, str]] = None):
@@ -353,8 +353,7 @@ class ManpageConverter(BaseConverter[OptionsManpageRenderer]):
         result = []
 
         if self._header is not None:
-            with self._header.open() as f:
-                result += f.read().splitlines()
+            result += self._header
         else:
             result += [
                 r'''.TH "CONFIGURATION\&.NIX" "5" "01/01/1980" "NixOS" "NixOS Reference Pages"''',
@@ -398,8 +397,7 @@ class ManpageConverter(BaseConverter[OptionsManpageRenderer]):
             result.append(".RE")
 
         if self._footer is not None:
-            with self._footer.open() as f:
-                result += f.read().splitlines()
+            result += self._footer
         else:
             result += [
                 r'''.SH "AUTHORS"''',
@@ -623,10 +621,21 @@ def _run_cli_db(args: argparse.Namespace) -> None:
             f.write(md.finalize())
 
 def _run_cli_manpage(args: argparse.Namespace) -> None:
+    header = None
+    footer = None
+
+    if args.header is not None:
+        with args.header.open() as f:
+            header = f.read().splitlines()
+
+    if args.footer is not None:
+        with args.footer.open() as f:
+            footer = f.read().splitlines()
+
     md = ManpageConverter(
         revision = args.revision,
-        header = args.header,
-        footer = args.footer,
+        header = header,
+        footer = footer,
     )
 
     with open(args.infile, 'r') as f: