OpenAstronomy / packaging-guide

A generic Python packaging guide and template. Slightly focused more towards scientific packages.
https://packaging-guide.openastronomy.org
41 stars 23 forks source link

render class-level and __init__-level docstrings #29

Closed bmorris3 closed 1 year ago

bmorris3 commented 1 year ago

Many packages across the Python scientific stack either set the following option in their conf.py

or mimic this behavior in their docs (scipy example)

Here I set that option in docs/conf.py so the documentation that the template, and explain the alternatives in a comment.