dev/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Actions1 Packages Projects Releases Wiki Activity

nixos-render-docs: add block and inline joiners

Browse Source 
these work together with render and renderInline to produce an output
from either of the two. rendering manpages will need both: to join
blocks with newlines, and to run some postprocessing and the rendered inlines.
This commit is contained in:
pennae 2023-02-01 21:04:28 +01:00 committed by pennae
parent 5a5255983b
commit 11daebd2d9
1 changed files with 8 additions and 3 deletions

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

@ -1,7 +1,7 @@
from abc import ABC from abc import ABC
from collections.abc import Mapping, MutableMapping, Sequence from collections.abc import Mapping, MutableMapping, Sequence
from frozendict import frozendict # type: ignore[attr-defined] from frozendict import frozendict # type: ignore[attr-defined]
from typing import Any, Callable, cast, Optional from typing import Any, Callable, cast, Iterable, Optional
import re import re
@ -79,6 +79,11 @@ class Renderer(markdown_it.renderer.RendererProtocol):
} }
self._admonition_stack = [] self._admonition_stack = []
def _join_block(self, ls: Iterable[str]) -> str:
return "".join(ls)
def _join_inline(self, ls: Iterable[str]) -> str:
return "".join(ls)
def admonition_open(self, token: Token, tokens: Sequence[Token], i: int, options: OptionsDict, def admonition_open(self, token: Token, tokens: Sequence[Token], i: int, options: OptionsDict,
env: MutableMapping[str, Any]) -> str: env: MutableMapping[str, Any]) -> str:
tag = token.info.strip() tag = token.info.strip()
@ -98,7 +103,7 @@ class Renderer(markdown_it.renderer.RendererProtocol):
return self.rules[token.type](tokens[i], tokens, i, options, env) return self.rules[token.type](tokens[i], tokens, i, options, env)
else: else:
raise NotImplementedError("md token not supported yet", token) raise NotImplementedError("md token not supported yet", token)
return "".join(map(lambda arg: do_one(*arg), enumerate(tokens))) return self._join_block(map(lambda arg: do_one(*arg), enumerate(tokens)))
def renderInline(self, tokens: Sequence[Token], options: OptionsDict, def renderInline(self, tokens: Sequence[Token], options: OptionsDict,
env: MutableMapping[str, Any]) -> str: env: MutableMapping[str, Any]) -> str:
def do_one(i: int, token: Token) -> str: def do_one(i: int, token: Token) -> str:
@ -106,7 +111,7 @@ class Renderer(markdown_it.renderer.RendererProtocol):
return self.rules[token.type](tokens[i], tokens, i, options, env) return self.rules[token.type](tokens[i], tokens, i, options, env)
else: else:
raise NotImplementedError("md token not supported yet", token) raise NotImplementedError("md token not supported yet", token)
return "".join(map(lambda arg: do_one(*arg), enumerate(tokens))) return self._join_inline(map(lambda arg: do_one(*arg), enumerate(tokens)))
def text(self, token: Token, tokens: Sequence[Token], i: int, options: OptionsDict, def text(self, token: Token, tokens: Sequence[Token], i: int, options: OptionsDict,
env: MutableMapping[str, Any]) -> str: env: MutableMapping[str, Any]) -> str: