[ADD] doc: basic index page instead of something completely blank

diff --git a/doc/_themes/odoodoc/layout.html b/doc/_themes/odoodoc/layout.html
index 3e75dad..1fcb690 100644 (file)
--- a/doc/_themes/odoodoc/layout.html
+++ b/doc/_themes/odoodoc/layout.html
@@ -35,7 +35,7 @@
                  main_navbar=False, titles_only=False) }}
       {% if github_link %}
         <p><a href="{{ github_link() }}" class="github">
-          Edit on GitHub
+          View on GitHub
         </a></p>
       {% endif %}
     </div>

diff --git a/doc/conf.py b/doc/conf.py
index 169c6b6..9ae72b9 100644 (file)
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -20,6 +20,7 @@ needs_sphinx = '1.1'
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
+    'sphinx.ext.ifconfig',
     'sphinx.ext.todo',
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
@@ -165,6 +166,9 @@ html_sidebars = {
 # base URL from which the finished HTML is served.
 #html_use_opensearch = ''
 
+# default must be set otherwise ifconfig blows up
+todo_include_todos = False
+
 intersphinx_mapping = {
     'python': ('https://docs.python.org/2/', None),
     'werkzeug': ('http://werkzeug.pocoo.org/docs/', None),

diff --git a/doc/images/view-on-github.png b/doc/images/view-on-github.png
new file mode 100644 (file)
index 0000000..afaabc4
Binary files /dev/null and b/doc/images/view-on-github.png differ

diff --git a/doc/index.rst b/doc/index.rst
index f83680e..2bb0aaa 100644 (file)
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -2,7 +2,31 @@
 odoo developer documentation
 ============================
 
-.. TODO: replace or style
+Welcome to the Odoo developer documentation.
+
+This documentation is incomplete and may contain errors, if you wish to
+contribute, every page should have a :guilabel:`View on Github` link:
+
+.. image:: images/view-on-github.*
+    :align: center
+
+Through this link you can edit documents and submit changes for review using
+`github's web interface
+<https://help.github.com/articles/editing-files-in-your-repository/>`_.
+Contributions are welcome and appreciated.
+
+.. todo:: what's the documentation's license?
+
+The documentation is currently organized in four sections:
+
+* :doc:`tutorials`, aimed at introducing the primary areas of developing Odoo
+  modules
+* :doc:`guides`, didactic documents covering more specific and specialized
+  areas of Odoo, trying to solve more specific problems
+* :doc:`reference`, which ought be the complete and canonical documentation
+  for Odoo subsystems
+* :doc:`modules`, documenting useful specialized modules and integration
+  methods (and currently empty)
 
 .. hidden toctree w/o titlesonly otherwise the titlesonly "sticks" to
    in-document toctrees and we can't have a toctree showing both "sibling"
@@ -16,4 +40,8 @@ odoo developer documentation
     reference
     modules
 
-.. todolist::
+.. ifconfig:: todo_include_todos
+
+    .. rubric:: Things to add and fix
+
+    .. todolist::

diff --git a/doc/modules.rst b/doc/modules.rst
index 7c90fce..16133d1 100644 (file)
--- a/doc/modules.rst
+++ b/doc/modules.rst
@@ -5,4 +5,3 @@ Module Objects
 .. toctree::
     :titlesonly:
 
-    modules/mail

diff --git a/doc/modules/mail.rst b/doc/modules/mail.rst
deleted file mode 100644 (file)
index 734fecc..0000000
--- a/doc/modules/mail.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-============
-Mail Threads
-============
-
-