commit 78052a22cbd1d33a88b1a46461b3b7f7ad41ac63 · pyrox.dev/nixpkgs

+14 -1

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

···

       81
        
           # mainly used by the options manpage converter to not emit extra quotes in defaults

     

       82
        
           # and examples where it's already clear from context that the following text is code.

     

       83
        
           inline_code_is_quoted: bool = True

     

       0
        
       
     

       84
        
       

     

       85
        
           _href_targets: dict[str, str]

     

       86
        
       

     

       0
        
       
     

       87
        
           _do_parbreak_stack: list[bool]

     

       88
        
           _list_stack: list[List]

     

       89
        
           _font_stack: list[str]

     
···

       92
        
                        parser: Optional[markdown_it.MarkdownIt] = None):

     

       93
        
               super().__init__(manpage_urls, parser)

     

       94
        
               self._href_targets = href_targets

     

       0
        
       
     

       95
        
               self._do_parbreak_stack = []

     

       96
        
               self._list_stack = []

     

       97
        
               self._font_stack = []

     
···

       154
        
           def link_open(self, token: Token, tokens: Sequence[Token], i: int, options: OptionsDict,

     

       155
        
                         env: MutableMapping[str, Any]) -> str:

     

       156
        
               href = cast(str, token.attrs['href'])

     

       0
        
       
     

       157
        
               text = ""

     

       158
        
               if tokens[i + 1].type == 'link_close' and href in self._href_targets:

     

       159
        
                   # TODO error or warning if the target can't be resolved

     
···

       162
        
               return f"\\fB{text}\0 <"

     

       163
        
           def link_close(self, token: Token, tokens: Sequence[Token], i: int, options: OptionsDict,

     

       164
        
                          env: MutableMapping[str, Any]) -> str:

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       165
        
               self._font_stack.pop()

     

       166
       -
               return f">\0 {self._font_stack[-1]}"

     

       167
        
           def list_item_open(self, token: Token, tokens: Sequence[Token], i: int, options: OptionsDict,

     

       168
        
                              env: MutableMapping[str, Any]) -> str:

     

       169
        
               self._enter_block()

···

       81
        
           # mainly used by the options manpage converter to not emit extra quotes in defaults

     

       82
        
           # and examples where it's already clear from context that the following text is code.

     

       83
        
           inline_code_is_quoted: bool = True

     

       84
       +
           link_footnotes: Optional[list[str]] = None

     

       85
        
       

     

       86
        
           _href_targets: dict[str, str]

     

       87
        
       

     

       88
       +
           _link_stack: list[str]

     

       89
        
           _do_parbreak_stack: list[bool]

     

       90
        
           _list_stack: list[List]

     

       91
        
           _font_stack: list[str]

     
···

       94
        
                        parser: Optional[markdown_it.MarkdownIt] = None):

     

       95
        
               super().__init__(manpage_urls, parser)

     

       96
        
               self._href_targets = href_targets

     

       97
       +
               self._link_stack = []

     

       98
        
               self._do_parbreak_stack = []

     

       99
        
               self._list_stack = []

     

       100
        
               self._font_stack = []

     
···

       157
        
           def link_open(self, token: Token, tokens: Sequence[Token], i: int, options: OptionsDict,

     

       158
        
                         env: MutableMapping[str, Any]) -> str:

     

       159
        
               href = cast(str, token.attrs['href'])

     

       160
       +
               self._link_stack.append(href)

     

       161
        
               text = ""

     

       162
        
               if tokens[i + 1].type == 'link_close' and href in self._href_targets:

     

       163
        
                   # TODO error or warning if the target can't be resolved

     
···

       166
        
               return f"\\fB{text}\0 <"

     

       167
        
           def link_close(self, token: Token, tokens: Sequence[Token], i: int, options: OptionsDict,

     

       168
        
                          env: MutableMapping[str, Any]) -> str:

     

       169
       +
               href = self._link_stack.pop()

     

       170
       +
               text = ""

     

       171
       +
               if self.link_footnotes is not None:

     

       172
       +
                   try:

     

       173
       +
                       idx = self.link_footnotes.index(href) + 1

     

       174
       +
                   except ValueError:

     

       175
       +
                       self.link_footnotes.append(href)

     

       176
       +
                       idx = len(self.link_footnotes)

     

       177
       +
                   text = "\\fR" + man_escape(f"[{idx}]")

     

       178
        
               self._font_stack.pop()

     

       179
       +
               return f">\0 {text}{self._font_stack[-1]}"

     

       180
        
           def list_item_open(self, token: Token, tokens: Sequence[Token], i: int, options: OptionsDict,

     

       181
        
                              env: MutableMapping[str, Any]) -> str:

     

       182
        
               self._enter_block()

+26 -4

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

···

       148
        
       

     

       149
        
               return [ l for part in blocks for l in part ]

     

       150
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       151
        
           def add_options(self, options: dict[str, Any]) -> None:

     

       152
        
               for (name, option) in options.items():

     

       153
       -
                   try:

     

       154
       -
                       self._options[name] = RenderedOption(option['loc'], self._convert_one(option))

     

       155
       -
                   except Exception as e:

     

       156
       -
                       raise Exception(f"Failed to render option {name}") from e

     

       157
        
       

     

       158
        
           @abstractmethod

     

       159
        
           def finalize(self) -> str: raise NotImplementedError()

     
···

       277
        
           __option_block_separator__ = ".sp"

     

       278
        
       

     

       279
        
           _options_by_id: dict[str, str]

     

       0
        
       
     

       280
        
       

     

       281
        
           def __init__(self, revision: str, markdown_by_default: bool):

     

       282
        
               self._options_by_id = {}

     

       283
        
               super().__init__({}, revision, markdown_by_default)

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       284
        
       

     

       285
        
           def add_options(self, options: dict[str, Any]) -> None:

     

       286
        
               for (k, v) in options.items():

     
···

       356
        
                       ".RS 4",

     

       357
        
                   ]

     

       358
        
                   result += opt.lines

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       359
        
                   result.append(".RE")

     

       360
        
       

     

       361
        
               result += [

···

       148
        
       

     

       149
        
               return [ l for part in blocks for l in part ]

     

       150
        
       

     

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

     

       152
       +
               try:

     

       153
       +
                   return RenderedOption(option['loc'], self._convert_one(option))

     

       154
       +
               except Exception as e:

     

       155
       +
                   raise Exception(f"Failed to render option {name}") from e

     

       156
       +
       

     

       157
        
           def add_options(self, options: dict[str, Any]) -> None:

     

       158
        
               for (name, option) in options.items():

     

       159
       +
                   self._options[name] = self._render_option(name, option)

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       160
        
       

     

       161
        
           @abstractmethod

     

       162
        
           def finalize(self) -> str: raise NotImplementedError()

     
···

       280
        
           __option_block_separator__ = ".sp"

     

       281
        
       

     

       282
        
           _options_by_id: dict[str, str]

     

       283
       +
           _links_in_last_description: Optional[list[str]] = None

     

       284
        
       

     

       285
        
           def __init__(self, revision: str, markdown_by_default: bool):

     

       286
        
               self._options_by_id = {}

     

       287
        
               super().__init__({}, revision, markdown_by_default)

     

       288
       +
       

     

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

     

       290
       +
               assert isinstance(self._md.renderer, OptionsManpageRenderer)

     

       291
       +
               links = self._md.renderer.link_footnotes = []

     

       292
       +
               result = super()._render_option(name, option)

     

       293
       +
               self._md.renderer.link_footnotes = None

     

       294
       +
               return result._replace(links=links)

     

       295
        
       

     

       296
        
           def add_options(self, options: dict[str, Any]) -> None:

     

       297
        
               for (k, v) in options.items():

     
···

       367
        
                       ".RS 4",

     

       368
        
                   ]

     

       369
        
                   result += opt.lines

     

       370
       +
                   if links := opt.links:

     

       371
       +
                       result.append(self.__option_block_separator__)

     

       372
       +
                       md_links = ""

     

       373
       +
                       for i in range(0, len(links)):

     

       374
       +
                           md_links += "\n" if i > 0 else ""

     

       375
       +
                           if links[i].startswith('#opt-'):

     

       376
       +
                               md_links += f"{i+1}. see the {{option}}`{self._options_by_id[links[i]]}` option"

     

       377
       +
                           else:

     

       378
       +
                               md_links += f"{i+1}. " + md_escape(links[i])

     

       379
       +
                       result.append(self._render(md_links))

     

       380
       +
       

     

       381
        
                   result.append(".RE")

     

       382
        
       

     

       383
        
               result += [

+4 -2

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

···

       7
        
       OptionLoc = str | dict[str, str]

     

       8
        
       Option = dict[str, str | dict[str, str] | list[OptionLoc]]

     

       9
        
       

     

       10
       -
       RenderedOption = NamedTuple('RenderedOption', [('loc', list[str]),

     

       11
       -
                                                      ('lines', list[str])])

     

       0
        
       
     

       0
        
       
     

       12
        
       

     

       13
        
       RenderFn = Callable[[Token, Sequence[Token], int, OptionsDict, MutableMapping[str, Any]], str]

···

       7
        
       OptionLoc = str | dict[str, str]

     

       8
        
       Option = dict[str, str | dict[str, str] | list[OptionLoc]]

     

       9
        
       

     

       10
       +
       class RenderedOption(NamedTuple):

     

       11
       +
           loc: list[str]

     

       12
       +
           lines: list[str]

     

       13
       +
           links: Optional[list[str]] = None

     

       14
        
       

     

       15
        
       RenderFn = Callable[[Token, Sequence[Token], int, OptionsDict, MutableMapping[str, Any]], str]

+14

pkgs/tools/nix/nixos-render-docs/src/tests/test_manpage.py

···

       27
        
           c = Converter({}, { '#foo1': "bar", "#foo2": "bar" })

     

       28
        
           assert (c._render("[a](#foo1) [](#foo2) [b](#bar1) [](#bar2)") ==

     

       29
        
                   "\\fBa\\fR \\fBbar\\fR \\fBb\\fR \\fB\\fR")

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0

···

       27
        
           c = Converter({}, { '#foo1': "bar", "#foo2": "bar" })

     

       28
        
           assert (c._render("[a](#foo1) [](#foo2) [b](#bar1) [](#bar2)") ==

     

       29
        
                   "\\fBa\\fR \\fBbar\\fR \\fBb\\fR \\fB\\fR")

     

       30
       +
       

     

       31
       +
       def test_collect_links() -> None:

     

       32
       +
           c = Converter({}, { '#foo': "bar" })

     

       33
       +
           assert isinstance(c._md.renderer, nixos_render_docs.manpage.ManpageRenderer)

     

       34
       +
           c._md.renderer.link_footnotes = []

     

       35
       +
           assert c._render("[a](link1) [b](link2)") == "\\fBa\\fR[1]\\fR \\fBb\\fR[2]\\fR"

     

       36
       +
           assert c._md.renderer.link_footnotes == ['link1', 'link2']

     

       37
       +
       

     

       38
       +
       def test_dedup_links() -> None:

     

       39
       +
           c = Converter({}, { '#foo': "bar" })

     

       40
       +
           assert isinstance(c._md.renderer, nixos_render_docs.manpage.ManpageRenderer)

     

       41
       +
           c._md.renderer.link_footnotes = []

     

       42
       +
           assert c._render("[a](link) [b](link)") == "\\fBa\\fR[1]\\fR \\fBb\\fR[1]\\fR"

     

       43
       +
           assert c._md.renderer.link_footnotes == ['link']