Qiskit / qiskit_sphinx_theme

A Sphinx theme and documentation guidelines for Qiskit and Qiskit Ecosystem projects
https://qisk.it/docs-guide
Apache License 2.0
15 stars 29 forks source link

Demo functions in module page in example docs #521

Closed Eric-Arellano closed 1 year ago

Eric-Arellano commented 1 year ago

We plan to reorganize some projects to have functions in their module pages. Turns out, you don't set this up by overriding the module.rst template. Instead, the docstring for the method needs to use .. autofunction:: rather than .. autosummary::.

I want to make sure the style always stays good, so this updates the example docs.