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 %}
- Edit on GitHub + View on GitHub
{% endif %} 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 00000000000..afaabc400b8 Binary files /dev/null and b/doc/images/view-on-github.png differ 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 +