Update documentation

Author: katyukha

docs/frequently-used-commands.md

@@ -54,8 +54,8 @@ Brief list of frequently used odoo-helper commands
 - `odoo-helper tr regenerate --lang uk_UA --file uk <addon1> [addon2]...` - regenerate translations for specified language for specified addons
 
 ### Other
-- `odoo-helper pip` - run `pip` inside current project's virtual environment [virtualenv](https://virtualenv.pypa.io/en/stable/).
-- `odoo-helper npm` - run `npm` inside current project's virtual environment [nodeenv](https://pypi.python.org/pypi/nodeenv)
+- `odoo-helper pip` - run [pip](https://pypi.org/project/pip/) inside current project's virtual environment [virtualenv](https://virtualenv.pypa.io/en/stable/).
+- `odoo-helper npm` - run [npm](https://www.npmjs.com/) inside current project's virtual environment [nodeenv](https://pypi.python.org/pypi/nodeenv)
 - `odoo-helper exec my-command` - run command inside project's virtual env
 
 

docs/index.md

@@ -48,7 +48,7 @@ After this you will have odoo and it's dependencies installed into *odoo-11.0* d
 This installation also creates *odoo-helper.conf* file inside project, which allows to use
 *odoo-helper* script to simplify interaction with this odoo installation.
 
-Description of *odoo-helper* project's directory structure is [here](./project-directory-structure.md')
+Description of *odoo-helper* project's directory structure is [here](./project-directory-structure.md)
 
 
 ### odoo-helper
@@ -57,18 +57,20 @@ This is the main script to manage Odoo instances installed by *odoo-install*
 
 Most of *odoo-helper-scripts* functionality is implemented as *subcommands* of `odoo-helper`.
 For example `odoo-helper server` contains server management commands like:
+
 - `odoo-helper server start`
 - `odoo-helper server stop`
 - `odoo-helper server restart`
 - etc
 
 All *odoo-helper commands* may be splited in two groups:
+
 - Odoo instance management commands
 - Other
 
 *Odoo instance management commands* are commands that manage Odoo instances installed using `odoo-install` script.
-Example of such commands may be `odoo-helper server` or `odoo-helper db` commands.
-These commands require to be ran inside Odoo instance directory (directory with Odoo installed using `odoo-install`)
+Example of such commands may be: `odoo-helper server` or `odoo-helper db` commands.
+These commands are required to be ran inside Odoo instance directory (directory with Odoo installed using `odoo-install`)
 or its subdirectories. Thus*odoo-helper* could find project/instance [config file](./odoo-helper-configuration.md).
 
 See [Frequently used commands](./frequently-used-commands.md) for more info about available commands
@@ -77,114 +79,180 @@ or just run `odoo-helper --help`
 
 ## Complete example
 
+Ensure *odoo-helper-scripts* pre-requirements are installed
+This step should be usualy ran one time, and is required to ensure that
+all odoo-helper dependencies are installed.
+
 ```bash
-# Install odoo-helper scripts pre-requirements.
-# This step should be usualy ran one time, and is required to ensure that
-# all odoo-helper dependencies installed.
 odoo-helper install pre-requirements
+```
+
+Install system dependencies for odoo version 10.0
+Note, that this option requires *sudo*.
 
-# Install system dependencies for odoo version 10.0
-# This option requires sudo.
+```bash
 odoo-helper install sys-deps 10.0;
+```
 
-# Install postgres and create there user with name='odoo' and password='odoo'
+Install [PostgreSQL Server](https://www.postgresql.org/) and create
+postgres user for Odoo with `name='odoo'` and `password='odoo'`
+
+```bash
 odoo-helper install postgres odoo odoo
+```
+
+Install *Odoo* 10.0 into *odoo-10.0* directory
 
-# Install odoo 10.0 into 'odoo-10.0' directory
+```bash
 odoo-install -i odoo-10.0 --odoo-version 10.0
+```
 
-# Change directory to that one contains installed Odoo instance.
-# This is required to make instance-management commands work
+Change directory to that one contains just installed Odoo instance.
+This is required to make instance-management commands work
+
+```bash
 cd odoo-10.0
+```
+
+Now You have *Odoo 10.0* installed in this directory.
+Note, that this odoo installation uses [virtualenv](https://virtualenv.pypa.io/en/stable/)
+(`venv` directory)
+Also you will find there `odoo-helper.conf` config file
 
-# Now You have odoo-10.0 installed in this directory.
-# Note, that this odoo installation uses virtual env (venv dir)
-# Also You will find there odoo-helper.conf config file
+So now You can run local odoo server (i.e `openerp-server` or `odoo.py` or `odoo-bin` script).
+Note that this command run's server in foreground.
+Configuration file `conf/odoo.conf` will be automatically used
 
-# So now You may run local odoo server (i.e openerp-server|odoo.py|odoo-bin script).
-# Note that this command run's server in foreground.
-# Configuration file conf/odoo.conf will be automatically used
+```bash
 odoo-helper server run
+```
 
-# Press Ctrl+C to stop seerver
+Press `Ctrl+C` to stop the server
 
-# To run server in backgroud use following command
+To run server in backgroud use following command:
+
+```bash
 odoo-helper server start
+```
+
+There are also additional server related commands (see [Frequently Used Commands](./frequently-used-commands.md)):
 
-# there are also additional server related commands:
+```bash
 odoo-helper server status
 odoo-helper server log
 odoo-helper server ps
 odoo-helper server restart
 odoo-helper server stop
+```
 
-# Also there are shourtcuts for these commands:
+Also there are shourtcuts for these commands
+
+```bash
 odoo-helper status
 odoo-helper log
 odoo-helper restart
 odoo-helper stop
+```
+
+Let's fetch modules from [OCA repository 'contract'](https://github.com/OCA/contract)
+Branch will be detected automatically by *odoo-helper-scripts*
 
-# Let's install fetch module contract from OCA repository 'contract'
-# Here branch will be detected automatically
+```bash
 odoo-helper fetch --oca contract
+```
 
-# Or alternatively
+Or alternatively
+
+```bash
 odoo-helper fetch --github OCA/contract --branch 10.0
+```
+
+Now look at `custom_addons/` directory, there will be placed links to addons
+from [OCA repository 'contract'](https://github.com/OCA/contract)
+But repository itself is placed in `repositories/` directory
 
-# Now look at custom_addons/ dir, there will be placed links to addons
-# from https://github.com/OCA/contract repository
-# But repository itself is placed in repositories/ directory
+Now let's run tests for these just installed modules
 
-# Now let's run tests for these just installed modules
+```bash
 odoo-helper test --create-test-db -m contract
+```
 
-# this will create test database (it will be dropt after test finished) and 
-# run tests for modules 'base_tags' and 'product_tags'
+This will create *test database* (it will be dropt after tests finished) and 
+run tests for `contract` module
 
-# Or we can run tests of whole directory, odoo-helper-scripts
-# will automaticaly detect installable addons and test it
-odoo-helper test -d ./repositories/contract
+Or we can run tests for all addons in specified directory, *odoo-helper-scripts*
+will automaticaly detect installable addons and run test for them
 
-# This will use standard test database, that will not be dropt after tests,
-# so we do not need to recreate database on each test run, which saves time
+```bash
+odoo-helper test --dir ./repositories/contract
+```
+
+This will use standard test database, that will not be dropt after tests,
+so we do not need to recreate database on each test run, which saves time
 
-# If You need color output from Odoo, you may use '--use-unbuffer' option,
-# but it depends on 'expect-dev' package.
+If you need color output from Odoo, you may use `--use-unbuffer` option,
+but it depends on `unbuffer` program that could be found in `expect-dev` package.
+
+```bash
 odoo-helper --use-unbuffer test -m contract
+```
+
+The one cool thing of *odoo-helper-scripts*, you may not remeber paths to odoo instalation directory,
+and if you change directory to another inside your *Odoo* project, everything will continue to work.
 
-# The one cool thing of odoo-helper script, you may not remeber paths to odoo instalation,
-# and if you change directory to another inside your odoo project, everything will continue to work.
+```bash
 cd custom_addons
 odoo-helper server status
 dooo-helper server restart
+```
 
-# So... let's install one more odoo version
-# go back to directory containing our projects (that one, where odoo-10.0 project is placed)
+So... let's install one more Odoo version
+go back to directory containing your projects (that one, where `odoo-10.0` project is placed in)
+
+```bash
 cd ../../
+```
 
-# Let's install odoo of version 8.0 here too.
-# First, install system dependencies for odoo version 8.0
-odoo-helper install sys-deps 8.0;
+Let's install *Odoo* of version 11.0 here too.
+First, install *system dependencies* for *Odoo* version 11.0
 
-# And when system dependencies installed, install odoo itself
-odoo-install --install-dir odoo-8.0 --odoo-version 8.0
-cd odoo-8.0
+```bash
+odoo-helper install sys-deps 11.0;
+```
+
+And when system dependencies installed, install *Odoo* itself
+
+```bash
+odoo-install --install-dir odoo-11.0 --odoo-version 11.0
+cd odoo-11.0
+```
+
+and install there for example addon [project_task_code](https://github.com/OCA/project/tree/11.0/project_task_code)
+from [project](https://github.com/OCA/project) [Odoo Community Association](https://odoo-community.org/) repository
+Note that *odoo-helper* script will automaticaly fetch branch named as server version in current install,
+if another branch was not specified
+
+```bash
+odoo-helper fetch --oca project -m project_task_code
+```
+
+and run tests for it
 
-# and install there for example addon 'project_sla' for 'project' Odoo Comutinty repository
-# Note  that odoo-helper script will automaticaly fetch branch named as server version in current install,
-# if another branch was not specified
-odoo-helper fetch --oca project -m project_sla
+```bash
+odoo-helper test --create-test-db -m project_task_code
+```
 
-# and run tests for it
-odoo-helper test --create-test-db -m project_sla
+Also if you want to install python packages in current installation environment,
+*odoo-helper* provides *pip alias* to *pip* installed in virtualenv of Odoo instance
 
+```bash
+odoo-helper pip install phonenumbers
+```
 
-# also if you want to install python packages in current installation environment, you may use command:
-odoo-helper fetch -p suds  # this installs 'suds' python package
+and as one more example, let's install aeroo-reports with dependancy to aeroolib in odoo 10.0
 
-# and as one more example, let's install aeroo-reports with dependancy to aeroolib in odoo 10.0
+```bash
 cd ../odoo-10.0
 odoo-helper fetch --github gisce/aeroo -n aeroo
 odoo-helper fetch -p git+https://github.com/jamotion/aeroolib#egg=aeroolib
-
 ```

mkdocs.yml

@@ -1,10 +1,19 @@
 site_name: odoo-helper-scripts
+site_author: Dmytro Katyukha
+site_description: 'Just a simple collection of odoo scripts. mostly to ease addons development process (allows to install and manage odoo instances in virtualenv)'
 site_url: https://odoo-helper-scripts.gitlab.io
+
+repo_url: https://gitlab.com/katyukha/odoo-helper-scripts
+repo_name: GitLab
+
 theme: cinder
+
 pages:
   - Home: index.md
   - Installation: installation.md
   - Frequently Used Commands: frequently-used-commands.md
   - Reference:
       - Configuration: odoo-helper-configuration.md
+      - Project Directory Structure: project-directory-structure.md
       - odoo-requirements.txt format: odoo-requirements-txt.md
+