search

ionelmc / cookiecutter-pylibrary

Enhanced cookiecutter template for Python libraries.
BSD 2-Clause "Simplified" License
1.25k stars 207 forks source link

Switch to autoapi from autodoc #187

Closed nealmcb closed 1 year ago

nealmcb commented 4 years ago

I was surprised to see that autodoc, as used in Sphinx, doesn't automate as much as I expected. It requires individually listing modules, ongoing maintenance based on new modules, and requires installing dependencies just to produce documentation.

Based on the advice to use autoapi at Sphinx autodoc is not automatic enough, I tried it and love it.

See the necessary diffs changes in our PR: r2b2 repo: Switch to autoapi from autodoc by nealmcb · Pull Request #7

ionelmc commented 4 years ago

I tried autoapi - it works but I think it should be an option. Perhaps sphinx_autoapi or sphinx_reference=(autoapi|autodoc). What do you think? You interested in making a PR?

nealmcb commented 4 years ago

Thanks for checking it out.

Supporting it via an option sounds good, and offhand having a sphinx_reference like that seems clear and flexible. I'll leave the default to you, but suggest it be made clear somehow what you get with each.

Sorry - I don't have time now to put a PR together.