Skip to content

Exclude static functions from c:autodoc #283

@RastislavTuranyi

Description

@RastislavTuranyi

Hi! I have been testing out hawkmoth for a new C library (it's great that it allows me to use the full features of sphinx in C!), but I have been surprised to find that the c:autodoc directive pulls everything into the docs, including static members (e.g. static functions), which is unlike the default sphinx automodule that by default ignores private members. As far as I can see, there is no way to control this behaviour in hawkmoth, unless I missed something?

If not, I wanted to ask whether you have considered adding control options to c:autodoc? I particularly would appreciate the ability to exclude static members, maybe via an option like :exclude-static-members: which would effectively function as the opposite of sphinx :private-members:. If this is of interest to you, I would be interested in helping out with this!

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions