Skip to content

[Feature Request] Support for :no-index: or equivalent to hide fully qualified class name and docstring. #331

@goffi-contrib

Description

@goffi-contrib

Hello,

Thanks for the work on this project.

I'm using autodoc_pydantic to document the settings of my project. As the documentation is for end-user, there is not need to show technical details, but at the moment I have this rendering:

Image

I don't see any options to hide this:

 pydantic settings libervia.backend.tools.config.TorSettings

    Tor configuration options

(i.e.; `pydantic settings followed by fully qualified class name, and the docstring).

Would it be possible to add a configuration option to hide them? I believe that this would be the equivalent of the :no-index: option of autodoc.

This would improve UX for settings.

Thanks!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions