Skip to content

docs: missing entries in autodoc-generated files #64

Open
@inge4pres

Description

@inge4pres

Describe the current state

Public API docs are published (via #52) but the only namespace visible is api/trace.
There is no sign of any metrics components, despite all of them being actually documented using the expected syntax.

In principle, all pub entries in src/sdk.zigshold be picked up by Zig's autodoc and rendeded in the website.
This is not happening and it might be due to either an error in build.zig or in how the symbols are exported/documented.

Describe the desired state

The public API docs hosted on the website reports all components that are expected to be seen, such as MeterProvider, Meter, etc...

Additional context

I am unsure why this issue is occurring. I suspect it might be related to #56.
To test modifications:

zig build docs
python -m http.server 8000 -d zig-out/docs

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentationhelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions