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

nixos-render-docs: rename manual docbook converter to docbook-section

Browse Source 
we'll soon add another docbook converter that does not emit a section as
a collection of chapters, but sections or chapters on their own. this
should clarify naming a bit before there can be any confusion.
This commit is contained in:
pennae 2023-02-07 13:52:29 +01:00
parent b59b0230ae
commit 67917ac102
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
nixos/doc/manual/default.nix
View File

@ -73,7 +73,7 @@ let
modulesDoc = runCommand "modules.xml" { modulesDoc = runCommand "modules.xml" {
nativeBuildInputs = [ pkgs.nixos-render-docs ]; nativeBuildInputs = [ pkgs.nixos-render-docs ];
} '' } ''
nixos-render-docs manual docbook \ nixos-render-docs manual docbook-section \
--manpage-urls ${manpageUrls} \ --manpage-urls ${manpageUrls} \
"$out" \ "$out" \
--section \ --section \

14
pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/manual.py
View File

@ -79,7 +79,7 @@ class ManualDocBookRenderer(DocBookRenderer):
info = f" language={quoteattr(token.info)}" if token.info != "" else "" info = f" language={quoteattr(token.info)}" if token.info != "" else ""
return f"<programlisting{info}>\n{escape(token.content)}</programlisting>" return f"<programlisting{info}>\n{escape(token.content)}</programlisting>"
class DocBookConverter(BaseConverter): class DocBookSectionConverter(BaseConverter):
__renderer__ = ManualDocBookRenderer __renderer__ = ManualDocBookRenderer
def finalize(self) -> str: def finalize(self) -> str:
@ -124,16 +124,16 @@ class ChaptersAction(argparse.Action):
if sections is None: raise argparse.ArgumentError(self, "no active section") if sections is None: raise argparse.ArgumentError(self, "no active section")
sections[-1].chapters.extend(map(Path, cast(Sequence[str], values))) sections[-1].chapters.extend(map(Path, cast(Sequence[str], values)))
def _build_cli_db(p: argparse.ArgumentParser) -> None: def _build_cli_db_section(p: argparse.ArgumentParser) -> None:
p.add_argument('--manpage-urls', required=True) p.add_argument('--manpage-urls', required=True)
p.add_argument("outfile") p.add_argument("outfile")
p.add_argument("--section", dest="contents", action=SectionAction, nargs=0) p.add_argument("--section", dest="contents", action=SectionAction, nargs=0)
p.add_argument("--section-id", dest="contents", action=SectionIDAction) p.add_argument("--section-id", dest="contents", action=SectionIDAction)
p.add_argument("--chapters", dest="contents", action=ChaptersAction, nargs='+') p.add_argument("--chapters", dest="contents", action=ChaptersAction, nargs='+')
def _run_cli_db(args: argparse.Namespace) -> None: def _run_cli_db_section(args: argparse.Namespace) -> None:
with open(args.manpage_urls, 'r') as manpage_urls: with open(args.manpage_urls, 'r') as manpage_urls:
md = DocBookConverter(json.load(manpage_urls)) md = DocBookSectionConverter(json.load(manpage_urls))
for section in args.contents: for section in args.contents:
md.add_section(section.id, section.chapters) md.add_section(section.id, section.chapters)
with open(args.outfile, 'w') as f: with open(args.outfile, 'w') as f:
@ -141,10 +141,10 @@ def _run_cli_db(args: argparse.Namespace) -> None:
def build_cli(p: argparse.ArgumentParser) -> None: def build_cli(p: argparse.ArgumentParser) -> None:
formats = p.add_subparsers(dest='format', required=True) formats = p.add_subparsers(dest='format', required=True)
_build_cli_db(formats.add_parser('docbook')) _build_cli_db_section(formats.add_parser('docbook-section'))
def run_cli(args: argparse.Namespace) -> None: def run_cli(args: argparse.Namespace) -> None:
if args.format == 'docbook': if args.format == 'docbook-section':
_run_cli_db(args) _run_cli_db_section(args)
else: else:
raise RuntimeError('format not hooked up', args) raise RuntimeError('format not hooked up', args)