machow / quartodoc

Generate API documentation with quarto
https://machow.github.io/quartodoc
MIT License
185 stars 21 forks source link

Support wildcards #118

Open schloerke opened 1 year ago

schloerke commented 1 year ago

Similar to R's {pkgdown}, I'd like to use startsWith("foo") or a wild card foo* to signify anything that matches the pattern.

Ex:

I have 25 functions under my_module that I'd like displayed. It would be nice if I could say:

quartodoc:
  style: pkgdown
  dir: reference
  package: mypkg
  sections:
    - title: Some functions
      desc: Functions to inspect docstrings.
      contents:
        - my_func
        - my_module.*

instead of

quartodoc:
  style: pkgdown
  dir: reference
  package: mypkg
  sections:
    - title: Some functions
      desc: Functions to inspect docstrings.
      contents:
        - my_func
        - my_module.func1
        - my_module.func2
        - my_module.func3
        - my_module.func4
        - my_module.func5
        - my_module.func6
        - ....

This is low priority

machow commented 1 year ago

Related to #80

machow commented 1 year ago

Similar issue arose for plotnine, where @has2k1 mentioned this would save him from typing many function names. In general, some kind of selection (e.g. pkgdown uses tidyselect) would be pretty handy