diff options
author | Bogumil Zebek <bogumil.zebek@nokia.com> | 2020-03-25 11:54:11 +0100 |
---|---|---|
committer | Zebek Bogumil <bogumil.zebek@nokia.com> | 2020-03-26 10:17:56 +0100 |
commit | 483ccbf2d8f0c71ebb15a4a47246a68a42e68f3e (patch) | |
tree | 607a4bc00b06c380bd25a692f8710bde80fe83d8 /docs/README.md | |
parent | 9600d1361dd6e662248fe0704d1436ae56d446a7 (diff) |
Documentation
Issue-ID: AAF-1091
Signed-off-by: Zebek Bogumil <bogumil.zebek@nokia.com>
Change-Id: I59df0545c4dd5adfde32c83988f89cd2d0c4676b
Diffstat (limited to 'docs/README.md')
-rw-r--r-- | docs/README.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..15deadea --- /dev/null +++ b/docs/README.md @@ -0,0 +1,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 + ``` |