API doc generation section readme

Author: adujardin

README.md

@@ -83,6 +83,29 @@ The [tutorials](tutorials) provide simple projects to show how to use each modul
 
 Please refer to the [examples](examples) README for more informations.
 
+## Generate the API documentation
+
+The documentation is provided in the [doc](./doc) folder and has to be built first.
+
+Sphinx is used to generates the html documentation.
+
+1. The zed-python-api has to be compiled and installed
+2. Make sure `sphinx` and `sphinx_rtd_theme` are installed
+
+```bash
+    cd doc
+    pip3 install -r requirements.txt
+```
+
+3. Generate the documentation by running the provided [Makefile](doc/Makefile) (Linux) or [make.bat](doc/make.bat) (Windows)
+
+```bash
+    make html
+```
+
+4. The documentation can be viewed in a browser by opening the generated [index.html file](doc/build/html/index.html) located in `doc/build/html/`
+
+
 ## Contributing
 
 Feel free to open an issue if you find a bug, or a pull request for bug fixes, features or other improvements.

doc/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd