Commit Graph

5 Commits

Author SHA1 Message Date
Oliver Beckstein
02a0cbd58b link to the propka3 command page 2020-06-19 22:04:05 -07:00
Oliver Beckstein
1c343a7d96 basic usage for propka3 command 2020-06-19 21:38:45 -07:00
Oliver Beckstein
26a5ab042e API docs for propka
- use autosummary (with custom module template)
- updated module docs for all modules so that they are included
  with sphinx autodocs
2020-06-19 16:25:24 -07:00
Oliver Beckstein
65856b39fb 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)
2020-06-19 15:18:04 -07:00
Oliver Beckstein
2bf031fd65 initial sphinx docs
starts #69

- basic structure
- RTD theme
- installation
- quickstart (more to do)
- references
- added start page with license and links to repo and issues
- authors in docs: papers and repo contributors (to be discussed)
2020-06-19 12:13:53 -07:00