2018-10-29 18:26:27 +00:00
|
|
|
# API documentation
|
|
|
|
|
|
2018-11-05 15:40:58 +00:00
|
|
|
The scripts in this folder build the API documentation for `mycroft-core`.
|
2018-10-29 18:26:27 +00:00
|
|
|
|
|
|
|
|
##
|
|
|
|
|
|
2018-11-05 15:40:58 +00:00
|
|
|
Activate the mycroft `venv`
|
2018-10-29 18:26:27 +00:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
source ../venv-activate.sh
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Install the documentation requirements
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
pip install -r requirements
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Create the documentation
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
make html
|
|
|
|
|
```
|
