tree: 10eb67240447b35fa5e4f9df6917851fb254eadc [path history] [tgz]
  1. _static/
  2. sections/
  3. .gitignore
  4. conf.py
  5. conf.yaml
  6. index.rst
  7. Makefile
  8. README.md
  9. requirements-docs.txt
  10. tox.ini
docs/README.md

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