Skip to content

Documentation: add Container to the API reference. #1122

Description

@morian

Hi!

I wrote some documentation for a small python module which uses construct, and noticed that there is no API reference to the Container class in the produced objects.inv. While this is a very minor issue, I thought it would be fine to report it here, and ask for it to be added in the current documentation!

Presence of this symbol can be checked using intersphinx as follow:

curl -s https://construct.readthedocs.io/en/latest/objects.inv | python -msphinx.ext.intersphinx /dev/stdin | grep Container

For context, my module is located here: https://github.com/morian/aio-ld2410
And I had to trick sphinx to tell him to ignore documenting the symbol here:
https://github.com/morian/aio-ld2410/blob/abc7506df43efeb436e332f8081d26c405a4591c/docs/conf.py#L61

Thanks!

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions