Package autosummary

[itepifanio]

I'm trying to generate autosummary docs of my library using a simple quartodoc config

project:
  type: website

website:
  title: "my doc"
  description: "my library does something cool"

quartodoc:
  package: my_package

But since I'm not directly exporting anything with __all__ the contents are always empty.

quartodoc:
  sections:
  - title: lighthouse_ml.app
    desc: 'Lighthouse ML App.


      Run as `python -m my_package`. See the project README for details.'
    contents: []
  package: my_package

My expectation was that quartodoc would walk over all my modules and generate all the content if anything was specified. There's some additional configuration to do that? Or do I have to explicitly tell my init files to export the objects via __all__ = ['MyClass'] to make it work?

[machow]

Hey, thanks for opening -- are you thinking something like pdoc? For example on the pdoc site if you click through the submodules section in the sidebar, it lets you sort of descend into all the submodules. I've mostly been focused on a flatter API reference (which might have a page that is a module, but not nest 2-levels deep), but am open to it (though would need to think through priority for this)

[itepifanio]

@machow sorry for the delay in the response. I wanted to created this repo to better display the difference. All the code it's dummy, just for example purposes.

I think that the pdoc submodule sections it's the ideal setup, but flattened it would work as well. My problem is that I have a large lib and I don't setup the __all__ in my modules (and I don't want to do it). When I'm trying to use quartodoc the following warning it's displayed and nothing it's rendered.

Autogenerating contents (since no contents specified in config)

WARNING: the module my_lib does not define an __all__ attribute. 
Generating documentation from all members of the module. 
Define __all__ in your package's __init__.py to specify exactly which functions it exports (and should be documented)

Sphinx can render the lib without explicit module declaration or the __all__ usage, which it's important for large libs that now wants automatic documentation of their API.

[AdamZh0u]

This feature will be super helpful for large projects, instead of having to manually define the structure.