Skip to content

Automatically generated API docs would be nice #796

@smheidrich

Description

@smheidrich

Is your feature request related to a problem? Please describe.
As far as I can tell, there are no automatically generated API docs and users are instead advised to have a look at the source code themselves. E.g. the docs on refactorings suggest:

Have a look at the rope.refactor package and its sub-modules.

Needless to say, this is not very convenient.

Describe the solution you'd like
It would be nice if there were auto-generated API docs for Rope's public interface.

Describe alternatives you've considered

  • Leave things as they are: People have a needlessly hard time using this library.
  • Add more hand-written docs: It's an option but probably much more effort than auto-generation.

Additional context
None.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    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