Skip to content

Latest commit

 

History

History
19 lines (13 loc) · 414 Bytes

DOCS.md

File metadata and controls

19 lines (13 loc) · 414 Bytes

Documentation

Documentation is generated with pdoc for all source code in the bench_executor module. The Numpy documentation style guide is used and must be honored when adding new code to this project.

How to?

Install pdoc:

pip install pdoc

Generate documentation and output to docs folder:

pdoc --docformat numpy bench_executor/*.py -o docs