Skip to content

MkDocs shortcomings #44

Description

@damskii9992

The following are shortcomings or missing features found when trying to create a documentation page with MkDocs:

  • Properties are listed as "writable" when they have a setter method, this cannot be overwritten (such as when the setter method simply provides a custom error message).
  • Cannot make custom groupings for attributes or functions/methods in the API reference, like group together constructor class methods or plotting methods and give them a heading.
  • In the API reference, when sorting by source, inherited attributes/methods comes before class methods, no option to reverse this order.

Metadata

Metadata

Assignees

No one assigned

    Labels

    [priority] ⚠️ label neededAutomatically added to issues without a [priority] label[scope] ⚠️ label neededAutomatically added to issues and PRs without a [scope] label

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions