Skip to content

rustdoc --json output format contains no doc comments #131113

Open

Description

What's the right way to invoke rustdoc so that it outputs in JSON format but also with doc comments?

I'm doing cargo +nightly rustdoc -- --output-format json -Z unstable-options and the resulting JSON file has "docs": null for all items! 😅

Please let me know how to tell rustdoc to include doc comments 🙂
Thanks 🙏

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

Metadata

Assignees

No one assigned

    Labels

    A-cross-crate-reexportsArea: Documentation that has been re-exported from a different crateArea: Documentation that has been re-exported from a different crateA-rustdoc-jsonArea: Rustdoc JSON backendArea: Rustdoc JSON backendS-needs-infoStatus: The issue lacks details necessary to triage or act on it.Status: The issue lacks details necessary to triage or act on it.S-needs-reproStatus: This issue has no reproduction and needs a reproduction to make progress.Status: This issue has no reproduction and needs a reproduction to make progress.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions