Documentation

A-Ops adopts a mixed documentation standard consisting of both code ( markdown style ) and api ( yaml style ).

The purpose of both documentation standards is to enable quick and simple generation of developer documentation.

Code

Class

<description>

## Attributes
<name>: <type>
    <description>

## Methods
<def>
    <description>

Function

<description>

## Parameters
<name>: <type>
    <description>

## Returns
<name>: <type>
    <description>

API

https://github.com/flasgger/flasgger