33< head >
44< meta http-equiv ="Content-Type " content ="text/html; charset=utf-8 " />
55< meta name ="generator " content ="Docutils: https://docutils.sourceforge.io/ " />
6- < title > Search Engine Serilizer Pydantic </ title >
6+ < title > README.rst </ title >
77< style type ="text/css ">
88
99/*
360360</ style >
361361</ head >
362362< body >
363- < div class ="document " id ="search-engine-serilizer-pydantic ">
364- < h1 class ="title "> Search Engine Serilizer Pydantic</ h1 >
363+ < div class ="document ">
365364
365+
366+ < a class ="reference external image-reference " href ="https://odoo-community.org/get-involved?utm_source=readme ">
367+ < img alt ="Odoo Community Association " src ="https://odoo-community.org/readme-banner-image " />
368+ </ a >
369+ < div class ="section " id ="search-engine-serilizer-pydantic ">
370+ < h1 > Search Engine Serilizer Pydantic</ h1 >
366371<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
367372!! This file is generated by oca-gen-addon-readme !!
368373!! changes will be overwritten. !!
369374!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
370- !! source digest: sha256:c1ccbbd934bcc84a6ba68660b56e79a875d6da98da0bea29e68ce453e054aae0
375+ !! source digest: sha256:236be848430cc180b1bb4656ce44987ef7996aaae4631e78c81e3d6215ae1913
371376!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
372- < p > < a class ="reference external image-reference " href ="https://odoo-community.org/page/development-status "> < img alt ="Beta " src ="https://img.shields.io/badge/maturity-Beta-yellow.png " /> </ a > < a class ="reference external image-reference " href ="http://www.gnu.org/licenses/agpl-3.0-standalone.html "> < img alt ="License: AGPL-3 " src ="https://img.shields.io/badge/licence-AGPL--3-blue.png " /> </ a > < a class ="reference external image-reference " href ="https://github.com/OCA/search-engine/tree/18.0/search_engine_serializer_pydantic "> < img alt ="OCA/search-engine " src ="https://img.shields.io/badge/github-OCA%2Fsearch--engine-lightgray.png?logo=github " /> </ a > < a class ="reference external image-reference " href ="https://translation.odoo-community.org/projects/search-engine-18-0/search-engine-18-0-search_engine_serializer_pydantic "> < img alt ="Translate me on Weblate " src ="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png " /> </ a > < a class ="reference external image-reference " href ="https://runboat.odoo-community.org/builds?repo=OCA/search-engine&target_branch=18.0 "> < img alt ="Try me on Runboat " src ="https://img.shields.io/badge/runboat-Try%20me-875A7B.png " /> </ a > </ p >
377+ < p > < a class ="reference external image-reference " href ="https://odoo-community.org/page/development-status "> < img alt ="Beta " src ="https://img.shields.io/badge/maturity-Beta-yellow.png " /> </ a > < a class ="reference external image-reference " href ="http://www.gnu.org/licenses/agpl-3.0-standalone.html "> < img alt ="License: AGPL-3 " src ="https://img.shields.io/badge/license-AGPL--3-blue.png " /> </ a > < a class ="reference external image-reference " href ="https://github.com/OCA/search-engine/tree/18.0/search_engine_serializer_pydantic "> < img alt ="OCA/search-engine " src ="https://img.shields.io/badge/github-OCA%2Fsearch--engine-lightgray.png?logo=github " /> </ a > < a class ="reference external image-reference " href ="https://translation.odoo-community.org/projects/search-engine-18-0/search-engine-18-0-search_engine_serializer_pydantic "> < img alt ="Translate me on Weblate " src ="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png " /> </ a > < a class ="reference external image-reference " href ="https://runboat.odoo-community.org/builds?repo=OCA/search-engine&target_branch=18.0 "> < img alt ="Try me on Runboat " src ="https://img.shields.io/badge/runboat-Try%20me-875A7B.png " /> </ a > </ p >
373378< p > This module is a technical module that define a new abstract class named
374379< tt class ="docutils literal "> PydandicModelSerializer</ tt > that inherit from
375380< tt class ="docutils literal "> odoo.addons.connector_search_engine.tools.serializer.ModelSerializer</ tt > </ p >
@@ -397,7 +402,7 @@ <h1 class="title">Search Engine Serilizer Pydantic</h1>
397402</ ul >
398403</ div >
399404< div class ="section " id ="use-cases-context ">
400- < h1 > < a class ="toc-backref " href ="#toc-entry-1 "> Use Cases / Context</ a > </ h1 >
405+ < h2 > < a class ="toc-backref " href ="#toc-entry-1 "> Use Cases / Context</ a > </ h2 >
401406< p > When you export records to a search engine, it’s common to want to
402407provides documentation about the fields exported and their
403408characteristics.</ p >
@@ -406,7 +411,7 @@ <h1><a class="toc-backref" href="#toc-entry-1">Use Cases / Context</a></h1>
406411documentation.</ p >
407412</ div >
408413< div class ="section " id ="usage ">
409- < h1 > < a class ="toc-backref " href ="#toc-entry-2 "> Usage</ a > </ h1 >
414+ < h2 > < a class ="toc-backref " href ="#toc-entry-2 "> Usage</ a > </ h2 >
410415< p > When you define a serializer based on a Pydantic model, your serializer
411416class must inherit from < tt class ="docutils literal "> PydanticModelSerializer</ tt > and implement the
412417method < tt class ="docutils literal "> get_model_class</ tt > to take advantage of the functionality
@@ -441,43 +446,43 @@ <h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
441446</ pre >
442447</ div >
443448< div class ="section " id ="known-issues-roadmap ">
444- < h1 > < a class ="toc-backref " href ="#toc-entry-3 "> Known issues / Roadmap</ a > </ h1 >
449+ < h2 > < a class ="toc-backref " href ="#toc-entry-3 "> Known issues / Roadmap</ a > </ h2 >
445450< ul class ="simple ">
446451< li > Add dedicated widget to display in a user friendly way the json schema
447452generated by the serializer on the index form.</ li >
448453</ ul >
449454</ div >
450455< div class ="section " id ="bug-tracker ">
451- < h1 > < a class ="toc-backref " href ="#toc-entry-4 "> Bug Tracker</ a > </ h1 >
456+ < h2 > < a class ="toc-backref " href ="#toc-entry-4 "> Bug Tracker</ a > </ h2 >
452457< p > Bugs are tracked on < a class ="reference external " href ="https://github.com/OCA/search-engine/issues "> GitHub Issues</ a > .
453458In case of trouble, please check there if your issue has already been reported.
454459If you spotted it first, help us to smash it by providing a detailed and welcomed
455460< a class ="reference external " href ="https://github.com/OCA/search-engine/issues/new?body=module:%20search_engine_serializer_pydantic%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior** "> feedback</ a > .</ p >
456461< p > Do not contact contributors directly about support or help with technical issues.</ p >
457462</ div >
458463< div class ="section " id ="credits ">
459- < h1 > < a class ="toc-backref " href ="#toc-entry-5 "> Credits</ a > </ h1 >
464+ < h2 > < a class ="toc-backref " href ="#toc-entry-5 "> Credits</ a > </ h2 >
460465< div class ="section " id ="authors ">
461- < h2 > < a class ="toc-backref " href ="#toc-entry-6 "> Authors</ a > </ h2 >
466+ < h3 > < a class ="toc-backref " href ="#toc-entry-6 "> Authors</ a > </ h3 >
462467< ul class ="simple ">
463468< li > ACSONE SA/NV</ li >
464469</ ul >
465470</ div >
466471< div class ="section " id ="contributors ">
467- < h2 > < a class ="toc-backref " href ="#toc-entry-7 "> Contributors</ a > </ h2 >
472+ < h3 > < a class ="toc-backref " href ="#toc-entry-7 "> Contributors</ a > </ h3 >
468473< ul class ="simple ">
469474< li > Laurent Mignon < a class ="reference external " href ="mailto:laurent.mignon@acsone.eu "> laurent.mignon@acsone.eu</ a > (< a class ="reference external " href ="https://www.acsone.eu/ "> https://www.acsone.eu/</ a > )</ li >
470475</ ul >
471476</ div >
472477< div class ="section " id ="other-credits ">
473- < h2 > < a class ="toc-backref " href ="#toc-entry-8 "> Other credits</ a > </ h2 >
478+ < h3 > < a class ="toc-backref " href ="#toc-entry-8 "> Other credits</ a > </ h3 >
474479< p > The development of this module has been financially supported by:</ p >
475480< ul class ="simple ">
476481< li > (ALCYON Belux)[< a class ="reference external " href ="https://www.alcyonbelux.be/fr/ "> https://www.alcyonbelux.be/fr/</ a > ]</ li >
477482</ ul >
478483</ div >
479484< div class ="section " id ="maintainers ">
480- < h2 > < a class ="toc-backref " href ="#toc-entry-9 "> Maintainers</ a > </ h2 >
485+ < h3 > < a class ="toc-backref " href ="#toc-entry-9 "> Maintainers</ a > </ h3 >
481486< p > This module is maintained by the OCA.</ p >
482487< a class ="reference external image-reference " href ="https://odoo-community.org ">
483488< img alt ="Odoo Community Association " src ="https://odoo-community.org/logo.png " />
@@ -492,5 +497,6 @@ <h2><a class="toc-backref" href="#toc-entry-9">Maintainers</a></h2>
492497</ div >
493498</ div >
494499</ div >
500+ </ div >
495501</ body >
496502</ html >
0 commit comments