e3fee2cf46
Prior to this commit, the Odoo documentation was mainly split between
two repositories: odoo/odoo/doc and odoo/documentation-user. Some bits
of documentation were also hosted elsewhere (e.g., wiki, upgrade, ...).
This was causing several problems among which:
- The theme, config, Makefile, and similar technical resources had to
be duplicated. This resulted in inconsistent layout, features, and
build environments from one documentation to another.
- Some pages did not fit either documentation as they were relevant
for both users and developers. Some were relevant to neither of the
two (e.g., DB management).
- Cross-doc references had to be absolute links and they broke often.
- Merging large image files in the developer documentation would bloat
the odoo/odoo repository. Some contributions had to be lightened to
avoid merging too many images (e.g., Odoo development tutorials).
- Long-time contributors to the user documentation were chilly about
going through the merging process of the developer documentation
because of the runbot, mergebot, `odoo-dev` repository, etc.
- Some contributors would look for the developer documentation in the
`odoo/documentation-user` repository.
- Community issues about the user documentation were submitted on the
`odoo/odoo` repository and vice-versa.
Merging all documentations in one repository will allow us to have one
place, one theme, one work process, and one set of tools (build
environment, ...) for all of the Odoo docs.
As this is a good opportunity to revamp the layout of the documentation,
a brand new theme replaces the old one. It features a new way to
navigate the documentation, centered on the idea of always letting the
reader know what is the context (enclosing section, child pages, page
structure ...) of the page they are reading. The previous theme would
quickly confuse readers as they navigated the documentation and followed
cross-application links.
The chance is also taken to get rid of all the technical dangling parts,
performance issues, and left-overs. Except for some page-specific JS
scripts, the Odoo theme Sphinx extension is re-written from scratch
based on the latest Sphinx release to benefit from the improvements and
ease future contributions.
task-2351938
task-2352371
task-2205684
task-2352544
Closes #945
87 lines
2.3 KiB
ReStructuredText
87 lines
2.3 KiB
ReStructuredText
|
|
.. _reference/controllers:
|
|
|
|
===============
|
|
Web Controllers
|
|
===============
|
|
|
|
Controllers
|
|
===========
|
|
|
|
Controllers need to provide extensibility, much like
|
|
:class:`~odoo.models.Model`, but can't use the same mechanism as the
|
|
pre-requisites (a database with loaded modules) may not be available yet (e.g.
|
|
no database created, or no database selected).
|
|
|
|
Controllers thus provide their own extension mechanism, separate from that of
|
|
models:
|
|
|
|
Controllers are created by :ref:`inheriting <python:tut-inheritance>` from :class:`~odoo.http.Controller`.
|
|
Routes are defined through methods decorated with :func:`~odoo.http.route`::
|
|
|
|
class MyController(odoo.http.Controller):
|
|
@route('/some_url', auth='public')
|
|
def handler(self):
|
|
return stuff()
|
|
|
|
To *override* a controller, :ref:`inherit <python:tut-inheritance>` from its
|
|
class and override relevant methods, re-exposing them if necessary::
|
|
|
|
class Extension(MyController):
|
|
@route()
|
|
def handler(self):
|
|
do_before()
|
|
return super(Extension, self).handler()
|
|
|
|
* decorating with :func:`~odoo.http.route` is necessary to keep the method
|
|
(and route) visible: if the method is redefined without decorating, it
|
|
will be "unpublished"
|
|
* the decorators of all methods are combined, if the overriding method's
|
|
decorator has no argument all previous ones will be kept, any provided
|
|
argument will override previously defined ones e.g.::
|
|
|
|
class Restrict(MyController):
|
|
@route(auth='user')
|
|
def handler(self):
|
|
return super(Restrict, self).handler()
|
|
|
|
will change ``/some_url`` from public authentication to user (requiring a
|
|
log-in)
|
|
|
|
API
|
|
===
|
|
|
|
.. _reference/http/routing:
|
|
|
|
Routing
|
|
-------
|
|
|
|
.. autofunction:: odoo.http.route
|
|
|
|
.. _reference/http/request:
|
|
|
|
Request
|
|
-------
|
|
|
|
The request object is automatically set on :data:`odoo.http.request` at
|
|
the start of the request
|
|
|
|
.. autoclass:: odoo.http.WebRequest
|
|
:members:
|
|
:member-order: bysource
|
|
.. autoclass:: odoo.http.HttpRequest
|
|
:members:
|
|
.. autoclass:: odoo.http.JsonRequest
|
|
:members:
|
|
|
|
Response
|
|
--------
|
|
|
|
.. autoclass:: odoo.http.Response
|
|
:members:
|
|
:member-order: bysource
|
|
|
|
.. maybe set this to document all the fine methods on Werkzeug's Response
|
|
object? (it works)
|
|
:inherited-members:
|