diff --git a/doc/README.rst b/doc/README.rst new file mode 100644 index 00000000000..b9b6d63f45a --- /dev/null +++ b/doc/README.rst @@ -0,0 +1,73 @@ +.. orphan:: true + +================== +Odoo Documentation +================== + +Odoo Theme +========== + +The Odoo Documentation theme is a bootstrap-based mix of http://odoo.com and +http://getbootstrap.com with additional changes and additions, bundled as +a Sphinx theme. + +The main style file is ``_themes/odoodoc/static/style.less``, it is not +converted on the fly and must be compiled manually when altere, using the +official node-based lessc_ tool. + +``odoodoc`` must be added as an extension to a project using the theme, it +fixes some discrepancies between bootstrap_ and Sphinx_ and adds a few +features: + +Sphinx Customizations +--------------------- + +* toctree bullet lists (HTML ``