itpp-labs / odoo-test-docs

All you need to know about automatic and manual testing in odoo

Source of the https://itpp.dev/test/ website

How to contribute

Initialization

• Fork this repo

• Clone to your machine

• Install dependencies:

  sudo pip install -r requirements.txt
  

Contribution

• Edit files in doc-src folder. Check documentations:

  • http://www.sphinx-doc.org/en/stable/rest.html
  • http://www.sphinx-doc.org/en/stable/domains.html
  • http://www.sphinx-doc.org/en/stable/markup/index.html
  • images.md

• Try it out:

  cd /path/to/odoo-test-docs/doc-src
  make html
  
  # (check warningn and errors in compilation logs and fix them if needed)
  
  # open result
  google-chrome _build/html/index.html
  

• Make commits, push, create Pull Request