documentation_link
Every Documentation arrow link in Odoo's Settings pages is one view widget: documentation_link. Its best trick is picking the right docs version for your server automatically.
| Technical name | documentation_link |
|---|---|
| Views | form (settings pages, |
| Module | web, present in every Odoo database |
| Used in core | 26 occurrences, including account, auth_oauth, base_setup, calendar, digest, google_gmail |
| Versions | Odoo 20.0, Odoo 19.0, Odoo 18.0, Odoo 17.0, Odoo 16.0 |
| No-code setup | No. The element is added in view XML (Studio has no documentation link element) |
| Alternatives | web_ribbon, popover_widget, iap_buy_more_credits |
What the documentation link widget does
What this means for your team
Supported options in Odoo 19
| Option | Type | What it does |
|---|---|---|
path | string (attribute) | Required. Either a docs path starting with / that gets the version-aware odoo.com prefix, or a full http(s) URL used verbatim. |
label | string (attribute) | Link text. Without it the widget renders its standard Documentation presentation. |
icon | string (attribute) | Icon class displayed with the link, for example a Font Awesome name. |
alert_link | boolean (attribute) | Adds Bootstrap's alert-link class so the link matches the surrounding alert's colors. Removed on the Odoo 20 development branch in favor of a class attribute. |
The version segment logic is worth knowing exactly. On a stable build, the server version info ends in final and the widget uses major.minor, for example 19.0, with a tilde in version names replaced by a dash. On any non-final build, alpha, beta or development, it links to master. So the same XML shows master docs on a staging build of the next version and stable docs in production.
Working examples
Reading extractProps: the URL test and the inline design
Version compatibility
| Version | Status | Notes |
|---|---|---|
| Odoo 20.0 | In development | Not released. The development branch replaces alert_link with a class attribute and centralizes the URL logic; see below. |
| Odoo 19.0 | Verified | All four attributes verified against the shipped source. |
| Odoo 18.0 | Verified | Same attributes and registration, verified in the 18.0 source. |
| Odoo 17.0 | Verified | Widget present with the same registry name. Not re-verified line by line for this page. |
| Odoo 16.0 | Verified | Widget present with the same registry name. Not re-verified line by line for this page. |
Upgrade note. Views using path, label and icon carry from 16 through 19 unchanged. Flag any alert_link usage in your custom modules now: the attribute disappears on the Odoo 20 development branch, replaced by a generic class attribute, so those views will need a one-line edit during a migration.
What is changing in Odoo 20
Common problems and fixes
| Symptom | Cause and fix |
|---|---|
| Link points at the master documentation | The server is a non-final build, alpha, beta or development, so the version segment falls back to master. Expected on staging builds; production stable releases link to their own version. |
| Link URL comes out mangled, docs prefix glued to my domain | The path did not start with http:// or https://, so it was treated as a docs path. Write the full scheme for external links. |
| Widget ignored or view fails to load | It was written as a field instead of a widget element. Use <widget name="documentation_link" .../>, not <field>. |
| Link renders but looks off inside an alert | alert_link not set, so the link keeps its default styling. Add alert_link="1" on 19, or class="alert-link" once on Odoo 20. |
| Docs link still shows the old version after upgrade | Someone hardcoded an absolute versioned URL instead of a relative path. Switch to a relative path so the widget versions it automatically. |
Documentation link widget vs the alternatives
| Widget | Best for | Key difference |
|---|---|---|
documentation_link | Learn-more links on settings pages, core-style | Pure view element with version-aware odoo.com URL building; stores nothing |
| web_ribbon | Unmissable record state on a form | A state banner driven by record data, not a navigation link |
popover_widget | Inline explanations that should not navigate away | Shows help in a popover on the page instead of linking out |
iap_buy_more_credits | Linking users to IAP credit purchase | A purpose-built commercial link, not general documentation |
Frequently asked questions
What is the documentation_link widget in Odoo?+
How does it pick the documentation version?+
Can I use documentation_link for my own company documentation?+
Why does my link point at the master docs on staging?+
What happens to alert_link in Odoo 20?+
Is there a Studio way to add a documentation link?+
Building settings pages users can self-serve?
Native-feeling configuration screens, with the right links, warnings and defaults, are what separate a polished custom module from a bare one. We build Odoo modules to core conventions on 16 through 19, documentation links included.
Book a free consultation