Skip to content

Generating API document #26

Open
@Atry

Description

@Atry

Feature Request

Is your feature request related to a problem? Please describe.
Usually a library author would like to publish their API document. It would be great if the functionality is available out-of-box.

Describe the solution you'd like

There is a solution to generate API document into README.md, as described at https://stackoverflow.com/a/57052392/955091

Describe alternatives you've considered
Other solutions might be publishing to GitHub Pages, but it would be more complicated for a starter template.

Are you willing to resolve this issue by submitting a Pull Request?

  • Yes, I have the time, and I know how to start.
  • Yes, I have the time, but I don't know how to start. I would need guidance.
  • No, I don't have the time, although I believe I could do it if I had the time...
  • No, I don't have the time and I wouldn't even know how to start.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions