autodoxysummary

Input

Using autodoxysummary, you can generate class-level documentation automatically.

.. autodoxysummary::
   :toctree: generated/

   OpenMM::NonbondedForce
   OpenMM::VerletIntegrator
   OpenMM::CustomIntegrator

This will generate a table to display, but also use the templating engine to generate class-level documentation for each of the classes which will be added to the toctree. You can also customize the layout of the generated pages by passing your own template.

---

Output

NonbondedForce	This class implements nonbonded interactions between particles, including a Coulomb force to represent electrostatics and a Lennard-Jones force to represent van der Waals interactions.
VerletIntegrator	This is an Integrator which simulates a System using the leap-frog Verlet algorithm.
CustomIntegrator	This is an Integrator that can be used to implemented arbitrary, user defined integration algorithms.
System	This class represents a molecular system.