design/api/README.md
author ymh <ymh.work@gmail.com>
Fri, 30 Nov 2018 22:04:27 +0100
changeset 186 3458941945e0
parent 116 672e3c4bbd0c
permissions -rw-r--r--
remove pylibmc from requirements as it is not used yet

# Generation of API documentation

The documentation use the api blueprint format ([documentation](https://apiblueprint.org)).

[Aglio](https://github.com/danielgtaylor/aglio) is used for rendering the documentation into html.

## install Aglio

```bash
$ npm install
```

### Available commands

- Build the documentation (file metacategory.html)
```bash
$ npm run build
```

This runs the following command:
```bash
$ aglio -i metacategory.apib -o metacategory.html
```

- Watch the documentation.
```bash
$ npm run watch
```

This runs the following command:
```bash
aglio -i metacategory.apib -s
```