Skip to content

Use pdoc rather than pdoc3 #324

@frankplow

Description

@frankplow

Is your feature request related to a problem? Please describe.
pdoc and pdoc3 are both continuations of a discontinued pdoc project. The two packages are conflicting. At present, mbed-tools uses pdoc3, however pdoc is a larger and more maintained library, also pdoc3 is the subject of some controversy.

Describe the solution you'd like
Change the project to depend on pdoc rather than pdoc3. As far as I can tell, this should be a near drop-in replacement, with just a handful of pdoc3s needing to be changed to pdocs.

Describe alternatives you've considered
The installation instructions say

We recommend installing mbed-tools in a Python virtual environment to avoid dependency conflicts.

Doing so mitigates this issue, but I think installation should be made as easy as possible without requiring a virtual environment.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions