documentation

History

Xavier Morel f10a033619 [FIX] double underlining of some document titles h2/second-level sections are overlined to separate them from one another. However if the document has no introductory paragraph (text between the h1/document title and the first subsection) the h1 has an underline and the section's overline, which isn't great. Fix CSS so a 2nd-level section which immediately follows an h1 does not get the overline.		2015-04-21 10:29:40 +02:00
..
static	[FIX] double underlining of some document titles	2015-04-21 10:29:40 +02:00
__init__.py	[ADD] initial closing	2015-02-11 09:22:56 +01:00
github.py	[ADD] initial closing	2015-02-11 09:22:56 +01:00
html_domain.py	[ADD] initial closing	2015-02-11 09:22:56 +01:00
layout.html	[ADD] initial closing	2015-02-11 09:22:56 +01:00
odoo_pygments.py	[ADD] initial closing	2015-02-11 09:22:56 +01:00
README.rst	[ADD] initial closing	2015-02-11 09:22:56 +01:00
sphinx_monkeypatch.py	[FIX] navbarification process	2015-04-09 10:37:03 +02:00
theme.conf	[ADD] initial closing	2015-02-11 09:22:56 +01:00

README.rst

:orphan:

Using the Odoo theme
====================

* copy the theme to one of your theme paths
* in your ``conf.py``,

    - add the package as the ``html_theme`` in your ``conf.py``::

        html_theme = 'odoodoc'

    - add the theme path to ``sys.path`` in your ``conf.py``::

        sys.path.insert(0, os.path.abspath('./_themes'))

    - add the theme as an extension::

        extensions = ['odoodoc']

Custom styling
--------------

If you need to add custom/own styles, add a CSS to your static files, set it
as ``html_style`` in your ``conf.py`` and add the following as its first
line::

    @import url(odoodoc.css)