Commit 9bfa2e36 authored by Viktor Kronvall's avatar Viktor Kronvall
Browse files

nixos-render-docs: take header and footer on CLI 

This commit generalizes nixos-render-docs for manpage generation
to take the header preamble and footer postscript as file paths
as CLI flags --header and --footer.
parent d9229abc

pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/options.py

+52 −28
Original line number Diff line number Diff line
@@ -8,6 +8,7 @@ import xml.sax.saxutils as xml 
from abc import abstractmethod

from collections.abc import Mapping, Sequence

from markdown_it.token import Token

from pathlib import Path

from typing import Any, Generic, Optional

from urllib.parse import quote
@@ -287,18 +288,27 @@ class ManpageConverter(BaseConverter[OptionsManpageRenderer]): 
    _links_in_last_description: Optional[list[str]] = None



    def __init__(self, revision: str,

                 header: Path | None,

                 footer: Path | None,

                 *,

                 # only for parallel rendering

                 _options_by_id: Optional[dict[str, str]] = None):

        super().__init__(revision)

        self._options_by_id = _options_by_id or {}

        self._renderer = OptionsManpageRenderer({}, self._options_by_id)

        self._header = header

        self._footer = footer



    def _parallel_render_prepare(self) -> Any:

        return (self._revision, { '_options_by_id': self._options_by_id })

        return (

            self._revision,

            self._header,

            self._footer,

            { '_options_by_id': self._options_by_id },

        )

    @classmethod

    def _parallel_render_init_worker(cls, a: Any) -> ManpageConverter:

        return cls(a[0], **a[1])

        return cls(a[0], a[1], a[2], **a[3])



    def _render_option(self, name: str, option: dict[str, Any]) -> RenderedOption:

        links = self._renderer.link_footnotes = []
@@ -342,6 +352,10 @@ class ManpageConverter(BaseConverter[OptionsManpageRenderer]): 
    def finalize(self) -> str:

        result = []



        if self._header is not None:

            with self._header.open() as f:

                result += f.read().splitlines()

        else:

            result += [

                r'''.TH "CONFIGURATION\&.NIX" "5" "01/01/1980" "NixOS" "NixOS Reference Pages"''',

                r'''.\" disable hyphenation''',
@@ -383,6 +397,10 @@ class ManpageConverter(BaseConverter[OptionsManpageRenderer]): 


            result.append(".RE")



        if self._footer is not None:

            with self._footer.open() as f:

                result += f.read().splitlines()

        else:

            result += [

                r'''.SH "AUTHORS"''',

                r'''.PP''',
@@ -573,6 +591,8 @@ def _build_cli_db(p: argparse.ArgumentParser) -> None: 


def _build_cli_manpage(p: argparse.ArgumentParser) -> None:

    p.add_argument('--revision', required=True)

    p.add_argument("--header", type=Path)

    p.add_argument("--footer", type=Path)

    p.add_argument("infile")

    p.add_argument("outfile")
@@ -603,7 +623,11 @@ def _run_cli_db(args: argparse.Namespace) -> None: 
            f.write(md.finalize())



def _run_cli_manpage(args: argparse.Namespace) -> None:

    md = ManpageConverter(revision = args.revision)

    md = ManpageConverter(

        revision = args.revision,

        header = args.header,

        footer = args.footer,

    )



    with open(args.infile, 'r') as f:

        md.add_options(json.load(f))