You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Stéphane Bidoul 9d167ea7b3
[CLA] Acsone (fix emails)
8 years ago
_static [ADD] contribution files and image removed at 2ad092b 9 years ago
_themes/odoodoc [IMP] doc: support disabling sidebar 8 years ago
cla [CLA] Acsone (fix emails) 8 years ago
howtos [IMP] doc: update website to scaffold 8 years ago
images [IMP] doc: indexify index 9 years ago
reference [FIX] doc: missing self params in examples 8 years ago
setup [FIX] doc: install.rst typo 8 years ago
Makefile [IMP] doc/howtos/backend: small fixes 9 years ago
README.rst [FIX] doc readme: the list of versions uses commas 9 years ago
api_integration.rst [IMP] doc: title of api page 9 years ago [CHG] doc: company officially renamed 9 years ago
git.rst [ADD] support for a version switcher in odoo theme thing 9 years ago
glossary.rst [ADD] doc: guide to the new API 9 years ago
index.rst [ADD] doc: setup documentation 9 years ago
reference.rst [IMP] doc: move translations to reference documentation 9 years ago
requirements.txt [ADD] documentation requirements 9 years ago
setup.rst [ADD] doc: setup documentation 9 years ago
tutorials.rst [IMP] wording and ordering of documentation index 9 years ago



Odoo Documentation

Odoo Theme

The Odoo Documentation theme is a bootstrap-based mix of and with additional changes and additions, bundled as
a Sphinx theme.

The main style file is ``_themes/odoodoc/static/style.less``, it is not
converted on the fly and must be compiled manually when altere, using the
official node-based lessc_ tool.

``odoodoc`` must be added as an extension to a project using the theme, it
fixes some discrepancies between bootstrap_ and Sphinx_ and adds a few

Sphinx Customizations

* toctree bullet lists (HTML ``<ul>``) are given the ``nav`` class
* the main navigation bar also gets the ``navbar-nav`` and ``navbar-right``
  set on its root (``navbar-right`` could probably be handled in CSS to avoid
  having it in the markup)
* tables are given the ``table`` class
* colspecs are removed from tables, tables should autolayout
* ``data-`` attributes are copied straight from the docutils node to the
  output HTML node
* an ``odoo`` pygments style based on the bootstrap_ documentation's
* the normal Sphinx sidebars are suppressed and a new sidebar is injected in
  ``div.document`` (``sidebar1`` is outside in the base Sphinx layout)
* HTML5 doctype

Additional features

* versions switcher, uses the ``canonical_root`` setting and an additional
  ``versions`` setting which should be a comma-separated list of available
  versions. Appends the each version and page name to the root, and displays
  a list of those links on the current page
* canonical urls, requires a ``canonical_root`` setting value, and optionally
  a ``canonical_branch`` (default: ``master``)
* :guilabel:`Edit on github` link in Sphinx pages if ``github_user`` and
  ``github_project`` are provided
* :guilabel:`[source]` links in autodoc content links to github with the same
  requirements (requires Sphinx 1.2)
* ``aphorism`` class for admonitions, makes the first line of the admonition
  inline and the same size as the admonition category (mostly for short,
  single-phrase admonitions)
* ``exercise`` directive, mostly for training-type documents, the
  ``solutions`` tag_ can be used to conditionally show e.g. solutions
* a number of straight-to-HTML directives:

    a straight div, can be used instead of ``container`` (which adds the
    ``container`` class to the div it generates, that's really not compatible
    with Bootstrap_)
    generates an ``<address>`` node
  a bunch of roles straight to HTML inline
    ``mark``, ``insert``, ``delete``, ``strikethrough``, ``small`, ``kbd`` and
    ``var`` generate the corresponding HTML element


* Sphinx 1.1, 1.2 for code Python code links
* sphinx-patchqueue (for the content, not the theme)

.. _lessc:
.. _bootstrap:
.. _sphinx:
.. _tag: