Skip to content

Generate documentation for all features #547

@Luro02

Description

@Luro02

Bug description

  • Would you like to work on a fix? maybe

The current documentation only includes the default features, making it difficult to discover the implementations of for example rmt or pcnt.

The rmt module is visible, but some types are missing from the documentation, and there is no indication that this requires the rmt-legacy feature.

To Reproduce

  1. Open documentation
  2. Look for the aforementioned modules

Expected behavior

Generate the documentation like for example tokio does; https://docs.rs/tokio/latest/tokio/
(Note the squares behind modules indicating that it is feature gated).

Environment

  • Crate (esp-idf-hal) version: [e.g. 0.44.1; type master if you use the crate from the GIT master branch]
  • ESP-IDF branch or tag: [e.g. release/v5.2, v5.2.1, etc.]
  • Target device (MCU): [e.g. esp32s3]
  • OS: [e.g. Ubuntu 20.04]

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions