Documentation (WIP)#

Docstrings#

  • Write a basic description of the implemented functions, the types and meanings of parameters and return values, and examples of their usage.

  • Write in accordance with the Google Python Style Guide.

  • See also Coding Conventions.

Documentation#

  • Create source files for documentation in a directory under docs.

  • The recommended document file format is markdown format.

  • Create documentation for any major feature additions.

Confirming rendering#

If you have added, changed, or modified documents, make sure that it renders correctly in the local environment. Move to the aiaccel directory and execute the following command to generate an API reference.

cd aiaccel
sphinx-apidoc --maxdepth 2 -f -o ./docs/source/api_reference/ ./aiaccel/

Move to aiaccel/docs and build html files to see how the document is rendered.

cd docs
make html