aboutsummaryrefslogtreecommitdiffstats
path: root/docs/README.md
blob: 15deadeacaa4116a5aafd4630deb76a721e12014 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
## AAF Certification Service documentation
###Requirements
    Python 3.x

To generate a documentation locally follow below steps.

1. Open **docs** folder in terminal
2. Install all required dependencies

    ```
    python install -r requirements-docs.txt
   ```
3. Generate local documentation
    ```
    make html
    ```
    After command execution the documentation will be available in **_build/html** folder.
4. Before you commit documentation changes please execute
    ```
    make clean
   ```