use autosummary to generate most of the API Reference

- custom _template/autosummary/module.rst to include docs
  for all module :members" (shows up directly after the summary
  tables)
- module docs should *not* contain autodocs for members, only general
  descriptions and examples
- all files inside api/ are autogenerated whenever sphinx is run
  (no need to add to the repository, hence excluded in .gitignore)
This commit is contained in:
Oliver Beckstein
2020-06-19 15:15:32 -07:00
parent 2bf031fd65
commit 65856b39fb
3 changed files with 75 additions and 1 deletions

9
.gitignore vendored
View File

@@ -4,4 +4,11 @@
# PIP stuff
*.egg-info
# Visual studio code
.vscode
.vscode
# editor files
*~
# generated files
docs/build
docs/source/api/*.rst