Added documentation

Author: smarie

docs/changelog.md

@@ -0,0 +1,5 @@
+# Changelog
+
+### 0.1.0 - First public version
+
+ * Initial fork from private repo

docs/index.md

@@ -0,0 +1,37 @@
+# yamlable
+
+*A thin wrapper of PyYaml to convert Python objects to YAML and back.*
+
+[![Build Status](https://travis-ci.org/smarie/python-yamlable.svg?branch=master)](https://travis-ci.org/smarie/python-yamlable) [![Tests Status](https://smarie.github.io/python-yamlable/junit/junit-badge.svg?dummy=8484744)](https://smarie.github.io/python-yamlable/junit/report.html) [![codecov](https://codecov.io/gh/smarie/python-yamlable/branch/master/graph/badge.svg)](https://codecov.io/gh/smarie/python-yamlable) [![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://smarie.github.io/python-yamlable/) [![PyPI](https://img.shields.io/badge/PyPI-yamlable-blue.svg)](https://pypi.python.org/pypi/yamlable/)
+
+
+
+## Installing
+
+```bash
+> pip install yamlable
+```
+
+## Usage
+
+TODO
+
+See [Usage](./usage) for a complete example with exceptions handling and more.
+
+
+## Main features / benefits
+
+ * TODO 
+
+
+## See Also
+
+[PyYaml documentation](http://pyyaml.org/wiki/PyYAMLDocumentation)
+
+### Others
+
+*Do you like this library ? You might also like [my other python libraries](https://github.com/smarie?utf8=%E2%9C%93&tab=repositories&q=&type=&language=python)* 
+
+## Want to contribute ?
+
+Details on the github page: [https://github.com/smarie/python-yamlable](https://github.com/smarie/python-yamlable)

docs/long_description.md

@@ -0,0 +1,9 @@
+# yamlable
+
+[![Build Status](https://travis-ci.org/smarie/python-yamlable.svg?branch=master)](https://travis-ci.org/smarie/python-yamlable) [![Tests Status](https://smarie.github.io/python-yamlable/junit/junit-badge.svg?dummy=8484744)](https://smarie.github.io/python-yamlable/junit/report.html) [![codecov](https://codecov.io/gh/smarie/python-yamlable/branch/master/graph/badge.svg)](https://codecov.io/gh/smarie/python-yamlable) [![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://smarie.github.io/python-yamlable/) [![PyPI](https://img.shields.io/badge/PyPI-yamlable-blue.svg)](https://pypi.python.org/pypi/yamlable/)
+
+*A thin wrapper of PyYaml to convert Python objects to YAML and back.*
+
+The documentation for users is available here: [https://smarie.github.io/python-yamlable/](https://smarie.github.io/python-yamlable/)
+
+A readme for developers is available here: [https://github.com/smarie/python-yamlable](https://github.com/smarie/python-yamlable)

docs/mkdocs.yml

@@ -0,0 +1,13 @@
+site_name: yamlable
+# site_description: 'A short description of my project'
+repo_url: https://github.com/smarie/python-pytest-cases
+pages:
+    - Home: index.md
+    - Usage details: usage.md
+    - Changelog: changelog.md
+theme: material  # readthedocs  mkdocs
+
+markdown_extensions:
+  - admonition  # to add notes such as http://squidfunk.github.io/mkdocs-material/extensions/admonition/
+  - codehilite(guess_lang=false)
+  - toc(permalink=true)

docs/usage.md

@@ -0,0 +1,5 @@
+# Usage
+
+You have seen in the [main page](./index) a small example to understand the concepts. Below we present other advanced usages.
+
+TODO