[ADD] doc: basic index page instead of something completely blank
This commit is contained in:
parent
8813815a22
commit
ed18ab7649
|
@ -35,7 +35,7 @@
|
||||||
main_navbar=False, titles_only=False) }}
|
main_navbar=False, titles_only=False) }}
|
||||||
{% if github_link %}
|
{% if github_link %}
|
||||||
<p><a href="{{ github_link() }}" class="github">
|
<p><a href="{{ github_link() }}" class="github">
|
||||||
Edit on GitHub
|
View on GitHub
|
||||||
</a></p>
|
</a></p>
|
||||||
{% endif %}
|
{% endif %}
|
||||||
</div>
|
</div>
|
||||||
|
|
|
@ -20,6 +20,7 @@ needs_sphinx = '1.1'
|
||||||
# Add any Sphinx extension module names here, as strings. They can be extensions
|
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||||
extensions = [
|
extensions = [
|
||||||
|
'sphinx.ext.ifconfig',
|
||||||
'sphinx.ext.todo',
|
'sphinx.ext.todo',
|
||||||
'sphinx.ext.autodoc',
|
'sphinx.ext.autodoc',
|
||||||
'sphinx.ext.intersphinx',
|
'sphinx.ext.intersphinx',
|
||||||
|
@ -165,6 +166,9 @@ html_sidebars = {
|
||||||
# base URL from which the finished HTML is served.
|
# base URL from which the finished HTML is served.
|
||||||
#html_use_opensearch = ''
|
#html_use_opensearch = ''
|
||||||
|
|
||||||
|
# default must be set otherwise ifconfig blows up
|
||||||
|
todo_include_todos = False
|
||||||
|
|
||||||
intersphinx_mapping = {
|
intersphinx_mapping = {
|
||||||
'python': ('https://docs.python.org/2/', None),
|
'python': ('https://docs.python.org/2/', None),
|
||||||
'werkzeug': ('http://werkzeug.pocoo.org/docs/', None),
|
'werkzeug': ('http://werkzeug.pocoo.org/docs/', None),
|
||||||
|
|
Binary file not shown.
After Width: | Height: | Size: 1.5 KiB |
|
@ -2,7 +2,31 @@
|
||||||
odoo developer documentation
|
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
|
.. hidden toctree w/o titlesonly otherwise the titlesonly "sticks" to
|
||||||
in-document toctrees and we can't have a toctree showing both "sibling"
|
in-document toctrees and we can't have a toctree showing both "sibling"
|
||||||
|
@ -16,4 +40,8 @@ odoo developer documentation
|
||||||
reference
|
reference
|
||||||
modules
|
modules
|
||||||
|
|
||||||
.. todolist::
|
.. ifconfig:: todo_include_todos
|
||||||
|
|
||||||
|
.. rubric:: Things to add and fix
|
||||||
|
|
||||||
|
.. todolist::
|
||||||
|
|
|
@ -5,4 +5,3 @@ Module Objects
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:titlesonly:
|
:titlesonly:
|
||||||
|
|
||||||
modules/mail
|
|
||||||
|
|
|
@ -1,5 +0,0 @@
|
||||||
============
|
|
||||||
Mail Threads
|
|
||||||
============
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue