b12f/nixpkgs
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

nixos-render-docs: refactor option docs restrictions

Browse source 
move the restrictions we care about into a mixin class. a few more
restrictions will appear soon and a few new converters as well, the
renderers of which need not have these restrictions already baked in by
accident (like the manpage renderer does right now).
This commit is contained in:
pennae 2023-02-10 07:45:25 +01:00 committed by pennae
parent 45619b3c4a
commit 82d066ffe3
1 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -171,7 +171,7 @@ class BaseConverter(Converter):
@abstractmethod
def finalize(self) -> str: raise NotImplementedError()
class OptionsDocBookRenderer(DocBookRenderer):
class OptionDocsRestrictions:
def heading_open(self, token: Token, tokens: Sequence[Token], i: int, options: OptionsDict,
env: MutableMapping[str, Any]) -> str:
raise RuntimeError("md token not supported in options doc", token)
@ -179,6 +179,7 @@ class OptionsDocBookRenderer(DocBookRenderer):
env: MutableMapping[str, Any]) -> str:
raise RuntimeError("md token not supported in options doc", token)
class OptionsDocBookRenderer(OptionDocsRestrictions, DocBookRenderer):
# TODO keep optionsDocBook diff small. remove soon if rendering is still good.
def ordered_list_open(self, token: Token, tokens: Sequence[Token], i: int, options: OptionsDict,
env: MutableMapping[str, Any]) -> str:
@ -287,7 +288,7 @@ class DocBookConverter(BaseConverter):
return "\n".join(result)
class OptionsManpageRenderer(ManpageRenderer):
class OptionsManpageRenderer(OptionDocsRestrictions, ManpageRenderer):
pass
class ManpageConverter(BaseConverter):