Documentation Notes

Intended Audience

People with some familiarity in programming.

• Mixed level experience and overlapping responsibilities in electrical engineering and software
• Electrical engineers that are able to use software as an analysis tool

Document Type

API (application programming interface) reference manual.

Necessary Information

• all public function signatures (covered by Doxygen)
• all environmental dependencies (covered in readme)
• typical use cases (covered in examples)
• performance limitations (to be covered in readme)
• known bugs (covered in readme)
• output format (to be covered in readme)
• contribution model (covered in readme)

Out of Scope

• python basics
• electrical engineering basics
• import/export to other simulation applications

Target output documentation format

HTML for intended integration into Github.

Document Generation Tool

Doxygen

Prerequisites

Recommended from software development team, to run documentation tool:

• public function signatures need to have docstrings
• some already exist and are in restructured text format. This is being converted to Doxygen format. Pycharm does not support Doxygen format directly and so its IDE configuration uses Epytext instead.

Editing changes needed to API documentation

• First page is blank - FIXED
• Readme needs to be moved into the main page - FIXED
• README: change "introduce as little error as possible." to "introduce as few errors as possible" - N/A - technical terminology
• 4th bullet point needs a comma after the word "user" and before "in there own script" - FIXED