Commit 895d9e69 authored by pennae's avatar pennae Committed by pennae
Browse files

nixos-render-docs: extract md code block factory 

the commonmark exporter can make good use once it appears.
parent 00bffb84

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

+13 −0
Original line number Diff line number Diff line
@@ -27,6 +27,19 @@ _md_escape_table = { 
def md_escape(s: str) -> str:

    return s.translate(_md_escape_table)



def md_make_code(code: str) -> str:

    # for multi-line code blocks we only have to count ` runs at the beginning

    # of a line, but this is much easier.

    multiline = '\n' in code

    longest, current = (0, 0)

    for c in code:

        current = current + 1 if c == '`' else 0

        longest = max(current, longest)

    # inline literals need a space to separate ticks from content, code blocks

    # need newlines. inline literals need one extra tick, code blocks need three.

    ticks, sep = ('`' * (longest + (3 if multiline else 1)), '\n' if multiline else ' ')

    return f"{ticks}{sep}{code}{sep}{ticks}"



AttrBlockKind = Literal['admonition', 'example']



AdmonitionKind = Literal["note", "caution", "tip", "important", "warning"]

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

+2 −13
Original line number Diff line number Diff line
@@ -15,7 +15,7 @@ import markdown_it 
from . import parallel

from .docbook import DocBookRenderer, make_xml_id

from .manpage import ManpageRenderer, man_escape

from .md import Converter, md_escape

from .md import Converter, md_escape, md_make_code

from .types import OptionLoc, Option, RenderedOption



def option_is(option: Option, key: str, typ: str) -> Optional[dict[str, str]]:
@@ -95,18 +95,7 @@ class BaseConverter(Converter): 
        if lit := option_is(option, key, 'literalMD'):

            return [ self._render(f"*{key.capitalize()}:*\n{lit['text']}") ]

        elif lit := option_is(option, key, 'literalExpression'):

            code = lit['text']

            # for multi-line code blocks we only have to count ` runs at the beginning

            # of a line, but this is much easier.

            multiline = '\n' in code

            longest, current = (0, 0)

            for c in code:

                current = current + 1 if c == '`' else 0

                longest = max(current, longest)

            # inline literals need a space to separate ticks from content, code blocks

            # need newlines. inline literals need one extra tick, code blocks need three.

            ticks, sep = ('`' * (longest + (3 if multiline else 1)), '\n' if multiline else ' ')

            code = f"{ticks}{sep}{code}{sep}{ticks}"

            code = md_make_code(lit['text'])

            return [ self._render(f"*{key.capitalize()}:*\n{code}") ]

        elif key in option:

            raise Exception(f"{key} has unrecognized type", option[key])