classes inside modules are not auto-rendering or being documenteed

[hamelsmu]

I'm trying to use quartodoc against bytewax in the bytewax branch of this repo

The quarto.yml file is like this:

project:
  type: website

website:
  title: "."
  navbar:
    left:
      - href: index.qmd
        text: Home
      - about.qmd

format:
  html:
    theme: cosmo
    css: styles.css
    toc: true

# tell quarto to read the generated sidebar
metadata-files:
  - _sidebar.yml

quartodoc:
  # the name used to import the package
  package: bytewax

  # write sidebar data to this file
  sidebar: _sidebar.yml

  sections:
    - title: General utilities
      desc: General purpose utilities.
      dynamic: true
      contents:
        # the functions being documented in the package.
        # you can refer to anything: class methods, modules, etc..
        - outputs
        - recovery
        - testing
    - title: Documentation utilities
      desc: Utilities for documentation.
      dynamic: true
      contents:
        - tracing
        - window
        - inputs

For example, there are many objects in the outputs module, however that page doesn't contain anything and looks like this without any functions, or classes even though those exist in this module.

You can repro this by checking out the bytewax branch of this repo and running quartodoc build followed by quarto preview

[machow]

From pairing w/ Hamel --

• Currently, we only document functions and attributes on modules. Let's plan to document everything on a module.
• Currently, we group functions by kind (e.g. attributes, functions). Let's have a mode that documents sequentially.
  • e.g. each object is documented in the order it appears in the source code
  • similar to mkdocstrings (see here), which looks great

edit: once we address these points, it should also improve the generation of fastcore (cf #194), by removing the function summary table.

[hamelsmu]

This looks like it is working now