From ed18ab7649dd441936025a46e5b8faa6a12defd5 Mon Sep 17 00:00:00 2001
From: Xavier Morel <xmo@openerp.com>
Date: Mon, 20 Oct 2014 10:00:20 +0200
Subject: [PATCH] [ADD] doc: basic index page instead of something completely
 blank

---
 doc/_themes/odoodoc/layout.html |   2 +-
 doc/conf.py                     |   4 ++++
 doc/images/view-on-github.png   | Bin 0 -> 1496 bytes
 doc/index.rst                   |  32 ++++++++++++++++++++++++++++++--
 doc/modules.rst                 |   1 -
 doc/modules/mail.rst            |   5 -----
 6 files changed, 35 insertions(+), 9 deletions(-)
 create mode 100644 doc/images/view-on-github.png
 delete mode 100644 doc/modules/mail.rst

diff --git a/doc/_themes/odoodoc/layout.html b/doc/_themes/odoodoc/layout.html
index 3e75dadac89..1fcb690454e 100644
--- 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 169c6b64a61..9ae72b90928 100644
--- 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
index 0000000000000000000000000000000000000000..afaabc400b8de21e0ffa574676f542ca83c09b63
GIT binary patch
literal 1496
zcmV;}1t<E6P)<h;3K|Lk000e1NJLTq007$n003+V0{{R3)RH&90001BP)t-s|NsB4
zR*j@ajN>E#qEfixqm!?j-ouZ!$83qFc*e1Co|>7Nov6n6`TD7yny9|unwzQJz^3-(
z#K__I!O-&S)VbjF{p;)M{rBAe|Mcwp|GK=q)X&+&r<vo~-_*Cu#6jsF000FuNkl<Z
zcwX$8$&TYN3`BLO*2U|R{{O$6V#)0oXkadLh^L`K!!$+N&<iCZ&6tO)tE<boUkbJ)
z5wW95QqAn+Xa)%_aKM3hD^M(d1DIax<IoO~=p~Mdltl_5Pqy{V7QGi4|H78==)*LK
z5+t#+*fog+aE!^r!OiAly)fYylf6W}ZkT}~Ou)oszx*Z=>wsu|4qM_5%wiWG$3w`N
zG?UiB^CG3Ol?hlSi)_eoX0F3>ToXmv5CU^~78?&*LYl&X1zI1=OwxLW0im+$It*ou
zBG0*Hw;UKn2;^~p?dzl1mOYDggNRhU?4Be=H)8%~+jdPD8I`SQE?ISwP8?~!%hFSn
zSw@735N^6SA!iPsKQh9ic{^`Os+;!0ym_!$V~!i!YkDDvkE)YisaOoxxt*VF@NqqO
zd@9+_)q`d~r0TId^oUAGc<7AkcAgM5kAj0NizPfw35H@}0N$GoPU28z=@^kaH7%ME
z(5PL_gS1S}48`2#+}-{NWhsk0z2Ef}hiv^D=)=_2)z#J2)z#J2)irP1wqE9~<?Hen
zhHlD-j~X4e5uV!m$S!pjcIXEF3w>vX|MQkg0wK&^<<%y;i$l*~3uZZfuzC8oTlap#
zP6I9%+cMp=<etRF?hn}pnBe&90Go9f%07UNq1Z?cu`3fj9>UHtVwKO>(QsZs6khAN
ze3(rN3CBUWSVJ`U?2luOUPE#FZZAt^GNtI+!QfKsF5_<<_-KHM;Sh`a@sn&eNl3Dt
zJ>>afy0cAQDiAE$PDEu3XEQqJ^oCnC)u!Rv*Zy)JWn<DN&poJX-hEsf<DE@q9iajX
zjDi$0l8p*@#Z^nP|8O@ivnEIY09h_8Esw*=rlEar%hr!TuPtxFyaB?!zRp)z=55~{
z@X9CIc)m*8Tao9j+2)JbcPO;7$zvuJDQm?9ATuoHUh_^ne4K4&rHt#+TEgc~jjeia
zVy{qehHwZ=tenR3nwUS1eZL}um3uNguIETYdyBYx6Z$qE4B<U@f&D!l%)~<f|LWg=
z!0+nn>gww1>gww1>gwwH)2_X(unogt0G2d6K7biHI_a|H{oiu3oP@%9(W@DT{*tDM
z81z*!rL;eqM{R#aZO|}kQ=8iUMbxG?wWZx5qTAE|XG;!i9OE`O0cUo7_cdVa5#tUp
zxECaV)s0Y|ryDSLZEQk|LW>2rp()*ZW6if?T#?-ADZoI>h8?U_R4Y9qYf>ZIjxptf
zA1UGv(9=>H`w3siipA0>Z^}notGPM0NtJC*SOT<x8zt&eZ(h)w1!g{T2IL|eei3m|
z#un;n985-{u+ms<n`f>K%#OUKg$?n9niCNi6y&fbd9(M_4Ky-x0w07%X1AqnI*$uQ
z)AcLyO!=g+v+Crq4JR3zrEu_?<~EsGY1f*8rj#sY>{hCca%`ENrNwvmJ{s7zArW;m
zE%lz1Jhr;Vo7BSQpvH-fVLiPVF_UCrrRiC^09+n^UE6-<mUG6(_S}<?jR6dAvENWW
z+0uR~eeeNfZX-+2G?3@XaqXE~|8ComOT~NJ1S>ZGHaFX1Zbv+0%#b4@9>AHYpseAh
zkL*p_kS5u2AcT--3in8A$sAm}Y$3ndLhgxevZlp;0~ZfArFh?*E7td!Ul5r^wwD}m
z$tk?<kyM=QHs1|$ow;n-$+f?W4a=GqHpV%zxsQLJ`KFk1f=}7f+nOdeI8HvDhkg%e
yY*U-s)TTDI>2DqFZEDkKG#ZUYqtR$I8qFUhG=pMqo{?by0000<MNUMnLSTa6Rr$dH

literal 0
HcmV?d00001

diff --git a/doc/index.rst b/doc/index.rst
index f83680e9ebd..2bb0aaafa9b 100644
--- 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 7c90fcecdd7..16133d13413 100644
--- 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
index 734feccb11f..00000000000
--- a/doc/modules/mail.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-============
-Mail Threads
-============
-
-