Skip to content

Commit d551193

Browse files
committed
[IMP] developer: add missing links in js doc
and slightly improve effect registry page closes #1296 Signed-off-by: Géry Debongnie (ged) <[email protected]>
1 parent 43193d6 commit d551193

File tree

5 files changed

+25
-17
lines changed

5 files changed

+25
-17
lines changed

content/developer/reference/frontend/framework_overview.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ the shared ``env`` object:
110110
* - `bus`
111111
- :ref:`main bus <frontend/framework/bus>`, used to coordinate some generic events
112112
* - `services`
113-
- all deployed :ref:`services <javascript/services>` (should usually be accessed
113+
- all deployed :ref:`services <frontend/services>` (should usually be accessed
114114
with the `useService` hook)
115115
* - `debug`
116116
- string. If non empty, the web client is in :ref:`debug mode <frontend/framework/debug_mode>`
@@ -144,11 +144,11 @@ services, components and hooks.
144144
Registries
145145
----------
146146

147-
Registries are basically a simple key/value mapping that stores some specific
148-
kind of objects. They are an important part of the extensibility of the UI:
149-
once some object is registered, the rest of the web client can use it. For
150-
example, the field registry contains all field components (or widgets) that
151-
can be used in views.
147+
:ref:`Registries <frontend/registries>` are basically a simple key/value mapping
148+
that stores some specific kind of objects. They are an important part of the
149+
extensibility of the UI: once some object is registered, the rest of the web
150+
client can use it. For example, the field registry contains all field components
151+
(or widgets) that can be used in views.
152152

153153
.. code-block:: javascript
154154
@@ -166,12 +166,12 @@ sub registry ``fields``.
166166
Services
167167
--------
168168

169-
Services are long lived pieces of code that provide a feature. They may be
170-
imported by components (with ``useService``) or by other services. Also, they
171-
can declare a set of dependencies. In that sense, services are basically a DI
172-
(dependency injection) system. For example, the ``notification`` service
173-
provides a way to display a notification, or the ``rpc`` service is the proper
174-
way to perform a request to the Odoo server.
169+
:ref:`Services <frontend/services>` are long lived pieces of code that provide a
170+
feature. They may be imported by components (with ``useService``) or by other
171+
services. Also, they can declare a set of dependencies. In that sense, services
172+
are basically a DI (dependency injection) system. For example, the ``notification``
173+
service provides a way to display a notification, or the ``rpc`` service is the
174+
proper way to perform a request to the Odoo server.
175175

176176
The following example registers a simple service that displays a notification
177177
every 5 second:
@@ -195,7 +195,7 @@ every 5 second:
195195
Components and Hooks
196196
--------------------
197197

198-
Components and hooks are ideas coming from the
198+
:ref:`Components <frontend/components>` and :ref:`hooks <frontend/hooks>` are ideas coming from the
199199
`Owl component system <https://github.com/odoo/owl/blob/master/doc/readme.md>`_.
200200
Odoo components are simply owl components that are part of the web client.
201201

content/developer/reference/frontend/hooks.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _frontend/hooks:
2+
13
=====
24
Hooks
35
=====

content/developer/reference/frontend/owl_components.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
.. _frontend/components:
12

23
==============
34
Owl Components

content/developer/reference/frontend/registries.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _frontend/registries:
2+
13
==========
24
Registries
35
==========
@@ -147,7 +149,7 @@ Service registry
147149
----------------
148150

149151
The service registry (category: `services`) contains all
150-
:ref:`services <javascript/services>` that should be activated by the Odoo
152+
:ref:`services <frontend/services>` that should be activated by the Odoo
151153
framework.
152154

153155
.. code-block:: javascript
@@ -244,5 +246,8 @@ Example:
244246
};
245247
}
246248
247-
:ref:`Effect registry<frontend/services/effect_registry>`
248-
---------------------------------------------------------
249+
Effect registry
250+
---------------
251+
252+
Contains the implementations of all available effects. See the section on the
253+
:ref:`effect service <frontend/services/effect_registry>` for more details.

content/developer/reference/frontend/services.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
.. _javascript/services:
2+
.. _frontend/services:
33

44
========
55
Services

0 commit comments

Comments
 (0)