Skip to content

API Documentation

Marios Papachristou edited this page Aug 14, 2018 · 5 revisions

Generated documentation

The API Documentation generated by pydoc3 for this project is located under the docs/ directory.

With make

Generate docs at the docs/ directory via

make docs

With pydoc3 (manpage-like)

  1. Navigate to 3gm folder
  2. Read the docs using:
pydoc3 <module-name>

where <module-name> is one of the modules.