Skip to content

chore: Flatten the API documentation to make it easier to search inside it #1407

@GaelVaroquaux

Description

@GaelVaroquaux

Which part of the documentation needs improvement?

The API page:
https://skore.probabl.ai/dev/reference/index.html

Describe the problem found in the documentation

I don't see all the functions available, so I can't:

  • Do a "crtl-F" to find a function
  • Easily find the doc of a function that I know that I'm looking for, as I need to figure out in which subpage it is

Suggested improvement

Fold in the subpages in the main API page

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    chore 🚧Maintenance and internal enhancement work to be doneready for dev 💻Issue specified enough and ready to be implemented

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions