Skip to content

Commit

Permalink
[IMP] Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
quentinDupont committed Nov 20, 2024
1 parent a81875d commit bd3300a
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 9 deletions.
15 changes: 13 additions & 2 deletions mrp_bom_simple_report/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ MRP BoM Simple Report
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:1a4344b8ba7251e08e7d5fc71dc2691e38d29d863d74e14619aed9e08b8d9782
!! source digest: sha256:72f9fc1242513999d966e58cf84dcceacbbe0b2154b558e4394d5f871cc51f3a
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
Expand All @@ -30,10 +30,21 @@ MRP BoM Simple Report

Adds a PDF report to print BoM(s) in a very simple way.

.. figure:: https://raw.githubusercontent.com/OCA/manufacture/16.0/mrp_bom_simple_report/static/description/bom_simple_report_new_action.png
.. figure:: https://raw.githubusercontent.com/OCA/manufacture/16.0/mrp_bom_simple_report/static/description/bom_simple_report_new_action.jpeg

.. figure:: https://raw.githubusercontent.com/OCA/manufacture/16.0/mrp_bom_simple_report/static/description/bom_simple_report_new_report.png

Compatible with [mrp_bom_widget_section_and_note_one2many](https://github.com/OCA/manufacture/tree/16.0/mrp_bom_widget_section_and_note_one2many)

Also compatible for being called in parent template. For this purpose, you need
to set params with t-set :
t-set="docs" → BoM
t-set="bom_intermediate_parent_bom_text" → nested BoM could be printed
t-set="bom_qty" → desired BoM quantity

Call this template with t-foreach to print multiple BoM with multiple BoM quantity
→ Example in grap-odoo-custom module : mrp_bom_wizard_production

**Table of contents**

.. contents::
Expand Down
13 changes: 12 additions & 1 deletion mrp_bom_simple_report/readme/DESCRIPTION.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
Adds a PDF report to print BoM(s) in a very simple way.

.. figure:: ../static/description/bom_simple_report_new_action.png
.. figure:: ../static/description/bom_simple_report_new_action.jpeg

.. figure:: ../static/description/bom_simple_report_new_report.png

Compatible with [mrp_bom_widget_section_and_note_one2many](https://github.com/OCA/manufacture/tree/16.0/mrp_bom_widget_section_and_note_one2many)

Also compatible for being called in parent template. For this purpose, you need
to set params with t-set :
t-set="docs" → BoM
t-set="bom_intermediate_parent_bom_text" → nested BoM could be printed
t-set="bom_qty" → desired BoM quantity

Call this template with t-foreach to print multiple BoM with multiple BoM quantity
→ Example in grap-odoo-custom module : mrp_bom_wizard_production
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 17 additions & 6 deletions mrp_bom_simple_report/static/description/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,11 @@

/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.
Despite the name, some widely supported CSS2 features are used.

See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
customize this style sheet.
Expand Down Expand Up @@ -275,7 +276,7 @@
margin-left: 2em ;
margin-right: 2em }

pre.code .ln { color: grey; } /* line numbers */
pre.code .ln { color: gray; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
Expand All @@ -301,7 +302,7 @@
span.pre {
white-space: pre }

span.problematic {
span.problematic, pre.problematic {
color: red }

span.section-subtitle {
Expand Down Expand Up @@ -367,16 +368,24 @@ <h1 class="title">MRP BoM Simple Report</h1>
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:1a4344b8ba7251e08e7d5fc71dc2691e38d29d863d74e14619aed9e08b8d9782
!! source digest: sha256:72f9fc1242513999d966e58cf84dcceacbbe0b2154b558e4394d5f871cc51f3a
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<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/manufacture/tree/16.0/mrp_bom_simple_report"><img alt="OCA/manufacture" src="https://img.shields.io/badge/github-OCA%2Fmanufacture-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/manufacture-16-0/manufacture-16-0-mrp_bom_simple_report"><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/manufacture&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p>Adds a PDF report to print BoM(s) in a very simple way.</p>
<div class="figure">
<img alt="https://raw.githubusercontent.com/OCA/manufacture/16.0/mrp_bom_simple_report/static/description/bom_simple_report_new_action.png" src="https://raw.githubusercontent.com/OCA/manufacture/16.0/mrp_bom_simple_report/static/description/bom_simple_report_new_action.png" />
<img alt="https://raw.githubusercontent.com/OCA/manufacture/16.0/mrp_bom_simple_report/static/description/bom_simple_report_new_action.jpeg" src="https://raw.githubusercontent.com/OCA/manufacture/16.0/mrp_bom_simple_report/static/description/bom_simple_report_new_action.jpeg" />
</div>
<div class="figure">
<img alt="https://raw.githubusercontent.com/OCA/manufacture/16.0/mrp_bom_simple_report/static/description/bom_simple_report_new_report.png" src="https://raw.githubusercontent.com/OCA/manufacture/16.0/mrp_bom_simple_report/static/description/bom_simple_report_new_report.png" />
</div>
<p>Compatible with [mrp_bom_widget_section_and_note_one2many](<a class="reference external" href="https://github.com/OCA/manufacture/tree/16.0/mrp_bom_widget_section_and_note_one2many">https://github.com/OCA/manufacture/tree/16.0/mrp_bom_widget_section_and_note_one2many</a>)</p>
<p>Also compatible for being called in parent template. For this purpose, you need
to set params with t-set :
t-set=”docs” → BoM
t-set=”bom_intermediate_parent_bom_text” → nested BoM could be printed
t-set=”bom_qty” → desired BoM quantity</p>
<p>Call this template with t-foreach to print multiple BoM with multiple BoM quantity
→ Example in grap-odoo-custom module : mrp_bom_wizard_production</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
Expand Down Expand Up @@ -414,7 +423,9 @@ <h2><a class="toc-backref" href="#toc-entry-4">Contributors</a></h2>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#toc-entry-5">Maintainers</a></h2>
<p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<a class="reference external image-reference" href="https://odoo-community.org">
<img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />
</a>
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.</p>
Expand Down

0 comments on commit bd3300a

Please sign in to comment.