API docs for propka

- use autosummary (with custom module template)
- updated module docs for all modules so that they are included
  with sphinx autodocs
This commit is contained in:
Oliver Beckstein
2020-06-19 16:25:24 -07:00
parent 65856b39fb
commit 26a5ab042e
28 changed files with 308 additions and 52 deletions

View File

@@ -8,7 +8,7 @@
Quickstart Guide
==================
PROPKA can be used either as a module or via the installed script :command:`propka3`; i.e., either
PROPKA can be used either as a module or via the installed script :program:`propka3`; i.e., either
.. code-block:: bash
@@ -26,9 +26,9 @@ works for invoking PROPKA.
Predicting protein residue |pKa| values
=======================================
Most users run PROPKA by invoking the program with a PDB file as its
argument; e.g., for PDB 1HPX_ (HIV-1 protease complexed with the
inhibitor KNI-272)
Most users run PROPKA by invoking the :program:`propka3` program with
a PDB file as its argument; e.g., for PDB 1HPX_ (HIV-1 protease
complexed with the inhibitor KNI-272)
.. code-block:: bash