Skip to content

docs: Drop auto-generated objects and members from Python API reference #40

@jan-kolarik

Description

@jan-kolarik

There is currently an issue that the Python API documentation contains many auto-generated classes, methods, and attributes that are not actually part of the official libpkgmanifest API.

This is likely not easily solvable by simply adjusting an AutoAPI option, such as removing undoc-members from autoapi_options, since we still need to include docstrings for all Python modules (as noted in readthedocs/sphinx-autoapi#448). The modules are automatically generated by SWIG, so the issue is not entirely under our control - at least, I am not currently aware of a direct way to mitigate it.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions