goerz / better-apidoc

A version of sphinx-apidoc with support for templating
BSD 2-Clause "Simplified" License
32 stars 6 forks source link

Include reasonable template examples in the repository #13

Closed janluke closed 5 years ago

janluke commented 5 years ago

I think that including a reasonable example of package.rst and module.rst would be of huge help for everyone who'd like to use this package. Many of the people who come here, do because they'd like to strip away the "Submodules/Subpackages" headers and the "module/package" suffixes. A template that does that would be a good start.

janluke commented 5 years ago

Ops, sorry, I'm blind. I didn't notice they are already there.