Skip to content

Commit ec6e945

Browse files
[IMP] report_qweb_pdf_cover: black, isort, prettier
1 parent 4c4e14e commit ec6e945

File tree

9 files changed

+85
-81
lines changed

9 files changed

+85
-81
lines changed

report_qweb_pdf_cover/README.rst

+30-32
Original file line numberDiff line numberDiff line change
@@ -17,22 +17,21 @@ Report QWeb PDF Cover
1717
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
1818
:alt: License: AGPL-3
1919
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github
20-
:target: https://github.com/OCA/reporting-engine/tree/16.0/report_qweb_pdf_cover
20+
:target: https://github.com/OCA/reporting-engine/tree/18.0/report_qweb_pdf_cover
2121
:alt: OCA/reporting-engine
2222
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
23-
:target: https://translation.odoo-community.org/projects/reporting-engine-16-0/reporting-engine-16-0-report_qweb_pdf_cover
23+
:target: https://translation.odoo-community.org/projects/reporting-engine-18-0/reporting-engine-18-0-report_qweb_pdf_cover
2424
:alt: Translate me on Weblate
2525
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
26-
:target: https://runboat.odoo-community.org/builds?repo=OCA/reporting-engine&target_branch=16.0
26+
:target: https://runboat.odoo-community.org/builds?repo=OCA/reporting-engine&target_branch=18.0
2727
:alt: Try me on Runboat
2828

2929
|badge1| |badge2| |badge3| |badge4| |badge5|
3030

31-
This module allows for front and back covers to be added to the generated PDF
32-
reports. They can be added as a separate page, at the beginning or the end of
33-
the report, but they can also overlap the first and last page of the actual
34-
report, respectively.
35-
31+
This module allows for front and back covers to be added to the
32+
generated PDF reports. They can be added as a separate page, at the
33+
beginning or the end of the report, but they can also overlap the first
34+
and last page of the actual report, respectively.
3635

3736
**Table of contents**
3837

@@ -42,50 +41,49 @@ report, respectively.
4241
Usage
4342
=====
4443

45-
To add a cover to a report, you need to access to the report's configuration,
46-
more specifically to the `Advanced Properties` tab. There, you will find two
47-
checkboxes, one for the front cover and another for the back cover.
48-
They both work the same, so let's focus on the front cover with an example.
49-
50-
* You must check the `Use Front Cover` checkbox to enable the front cover. You
51-
will see that a new checkbox and a PDF file widget appear.
52-
53-
* If you want the front cover to overlap with the first page of the PDF report,
54-
you should also check the `Overlap Front Cover` checkbox. Leave it unchecked
55-
if you don't want the front cover to overlap with the first page.
56-
57-
* The last step would be to upload the PDF file that will be used as the front
58-
cover. You can do this by clicking on the PDF file widget and selecting the
59-
file.
60-
61-
* Important! The file must be a PDF file, and it should have only one page. If
62-
it has more pages, only the first one will be used.
44+
To add a cover to a report, you need to access to the report's
45+
configuration, more specifically to the Advanced Properties tab. There,
46+
you will find two checkboxes, one for the front cover and another for
47+
the back cover. They both work the same, so let's focus on the front
48+
cover with an example.
49+
50+
- You must check the Use Front Cover checkbox to enable the front
51+
cover. You will see that a new checkbox and a PDF file widget appear.
52+
- If you want the front cover to overlap with the first page of the PDF
53+
report, you should also check the Overlap Front Cover checkbox. Leave
54+
it unchecked if you don't want the front cover to overlap with the
55+
first page.
56+
- The last step would be to upload the PDF file that will be used as
57+
the front cover. You can do this by clicking on the PDF file widget
58+
and selecting the file.
59+
- Important! The file must be a PDF file, and it should have only one
60+
page. If it has more pages, only the first one will be used.
6361

6462
Bug Tracker
6563
===========
6664

6765
Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/issues>`_.
6866
In case of trouble, please check there if your issue has already been reported.
6967
If you spotted it first, help us to smash it by providing a detailed and welcomed
70-
`feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_qweb_pdf_cover%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
68+
`feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_qweb_pdf_cover%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
7169

7270
Do not contact contributors directly about support or help with technical issues.
7371

7472
Credits
7573
=======
7674

7775
Authors
78-
~~~~~~~
76+
-------
7977

8078
* ForgeFlow
8179

8280
Contributors
83-
~~~~~~~~~~~~
81+
------------
8482

85-
* Laura Cazorla <laura.cazorla@forgeflow.com>
83+
- Laura Cazorla <laura.cazorla@forgeflow.com>
8684

8785
Maintainers
88-
~~~~~~~~~~~
86+
-----------
8987

9088
This module is maintained by the OCA.
9189

@@ -97,6 +95,6 @@ OCA, or the Odoo Community Association, is a nonprofit organization whose
9795
mission is to support the collaborative development of Odoo features and
9896
promote its widespread use.
9997

100-
This module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/16.0/report_qweb_pdf_cover>`_ project on GitHub.
98+
This module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/18.0/report_qweb_pdf_cover>`_ project on GitHub.
10199

102100
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

report_qweb_pdf_cover/pyproject.toml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[build-system]
2+
requires = ["whool"]
3+
build-backend = "whool.buildapi"
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
- Laura Cazorla \<<laura.cazorla@forgeflow.com>\>

report_qweb_pdf_cover/readme/CONTRIBUTORS.rst

-1
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
This module allows for front and back covers to be added to the
2+
generated PDF reports. They can be added as a separate page, at the
3+
beginning or the end of the report, but they can also overlap the first
4+
and last page of the actual report, respectively.

report_qweb_pdf_cover/readme/DESCRIPTION.rst

-5
This file was deleted.

report_qweb_pdf_cover/readme/USAGE.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
To add a cover to a report, you need to access to the report's
2+
configuration, more specifically to the Advanced Properties tab. There,
3+
you will find two checkboxes, one for the front cover and another for
4+
the back cover. They both work the same, so let's focus on the front
5+
cover with an example.
6+
7+
- You must check the Use Front Cover checkbox to enable the front cover.
8+
You will see that a new checkbox and a PDF file widget appear.
9+
- If you want the front cover to overlap with the first page of the PDF
10+
report, you should also check the Overlap Front Cover checkbox. Leave
11+
it unchecked if you don't want the front cover to overlap with the
12+
first page.
13+
- The last step would be to upload the PDF file that will be used as the
14+
front cover. You can do this by clicking on the PDF file widget and
15+
selecting the file.
16+
- Important! The file must be a PDF file, and it should have only one
17+
page. If it has more pages, only the first one will be used.

report_qweb_pdf_cover/readme/USAGE.rst

-18
This file was deleted.

report_qweb_pdf_cover/static/description/index.html

+30-25
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@
88

99
/*
1010
:Author: David Goodger (goodger@python.org)
11-
:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
11+
:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
1212
:Copyright: This stylesheet has been placed in the public domain.
1313
1414
Default cascading style sheet for the HTML output of Docutils.
15+
Despite the name, some widely supported CSS2 features are used.
1516
1617
See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
1718
customize this style sheet.
@@ -274,7 +275,7 @@
274275
margin-left: 2em ;
275276
margin-right: 2em }
276277

277-
pre.code .ln { color: grey; } /* line numbers */
278+
pre.code .ln { color: gray; } /* line numbers */
278279
pre.code, code { background-color: #eeeeee }
279280
pre.code .comment, code .comment { color: #5C6576 }
280281
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
@@ -300,7 +301,7 @@
300301
span.pre {
301302
white-space: pre }
302303

303-
span.problematic {
304+
span.problematic, pre.problematic {
304305
color: red }
305306

306307
span.section-subtitle {
@@ -368,11 +369,11 @@ <h1 class="title">Report QWeb PDF Cover</h1>
368369
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
369370
!! source digest: sha256:1287ee62d703ed048f33bb706f289cf01e5c99bead22b8b612d69e88071a4d67
370371
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
371-
<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/reporting-engine/tree/16.0/report_qweb_pdf_cover"><img alt="OCA/reporting-engine" src="https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/reporting-engine-16-0/reporting-engine-16-0-report_qweb_pdf_cover"><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/reporting-engine&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
372-
<p>This module allows for front and back covers to be added to the generated PDF
373-
reports. They can be added as a separate page, at the beginning or the end of
374-
the report, but they can also overlap the first and last page of the actual
375-
report, respectively.</p>
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/reporting-engine/tree/18.0/report_qweb_pdf_cover"><img alt="OCA/reporting-engine" src="https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/reporting-engine-18-0/reporting-engine-18-0-report_qweb_pdf_cover"><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/reporting-engine&amp;target_branch=18.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
373+
<p>This module allows for front and back covers to be added to the
374+
generated PDF reports. They can be added as a separate page, at the
375+
beginning or the end of the report, but they can also overlap the first
376+
and last page of the actual report, respectively.</p>
376377
<p><strong>Table of contents</strong></p>
377378
<div class="contents local topic" id="contents">
378379
<ul class="simple">
@@ -388,29 +389,31 @@ <h1 class="title">Report QWeb PDF Cover</h1>
388389
</div>
389390
<div class="section" id="usage">
390391
<h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
391-
<p>To add a cover to a report, you need to access to the report’s configuration,
392-
more specifically to the <cite>Advanced Properties</cite> tab. There, you will find two
393-
checkboxes, one for the front cover and another for the back cover.
394-
They both work the same, so let’s focus on the front cover with an example.</p>
392+
<p>To add a cover to a report, you need to access to the report’s
393+
configuration, more specifically to the Advanced Properties tab. There,
394+
you will find two checkboxes, one for the front cover and another for
395+
the back cover. They both work the same, so let’s focus on the front
396+
cover with an example.</p>
395397
<ul class="simple">
396-
<li>You must check the <cite>Use Front Cover</cite> checkbox to enable the front cover. You
397-
will see that a new checkbox and a PDF file widget appear.</li>
398-
<li>If you want the front cover to overlap with the first page of the PDF report,
399-
you should also check the <cite>Overlap Front Cover</cite> checkbox. Leave it unchecked
400-
if you don’t want the front cover to overlap with the first page.</li>
401-
<li>The last step would be to upload the PDF file that will be used as the front
402-
cover. You can do this by clicking on the PDF file widget and selecting the
403-
file.</li>
404-
<li>Important! The file must be a PDF file, and it should have only one page. If
405-
it has more pages, only the first one will be used.</li>
398+
<li>You must check the Use Front Cover checkbox to enable the front
399+
cover. You will see that a new checkbox and a PDF file widget appear.</li>
400+
<li>If you want the front cover to overlap with the first page of the PDF
401+
report, you should also check the Overlap Front Cover checkbox. Leave
402+
it unchecked if you don’t want the front cover to overlap with the
403+
first page.</li>
404+
<li>The last step would be to upload the PDF file that will be used as
405+
the front cover. You can do this by clicking on the PDF file widget
406+
and selecting the file.</li>
407+
<li>Important! The file must be a PDF file, and it should have only one
408+
page. If it has more pages, only the first one will be used.</li>
406409
</ul>
407410
</div>
408411
<div class="section" id="bug-tracker">
409412
<h1><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h1>
410413
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/reporting-engine/issues">GitHub Issues</a>.
411414
In case of trouble, please check there if your issue has already been reported.
412415
If you spotted it first, help us to smash it by providing a detailed and welcomed
413-
<a class="reference external" href="https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_qweb_pdf_cover%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
416+
<a class="reference external" href="https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_qweb_pdf_cover%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
414417
<p>Do not contact contributors directly about support or help with technical issues.</p>
415418
</div>
416419
<div class="section" id="credits">
@@ -430,11 +433,13 @@ <h2><a class="toc-backref" href="#toc-entry-5">Contributors</a></h2>
430433
<div class="section" id="maintainers">
431434
<h2><a class="toc-backref" href="#toc-entry-6">Maintainers</a></h2>
432435
<p>This module is maintained by the OCA.</p>
433-
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
436+
<a class="reference external image-reference" href="https://odoo-community.org">
437+
<img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />
438+
</a>
434439
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
435440
mission is to support the collaborative development of Odoo features and
436441
promote its widespread use.</p>
437-
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/reporting-engine/tree/16.0/report_qweb_pdf_cover">OCA/reporting-engine</a> project on GitHub.</p>
442+
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/reporting-engine/tree/18.0/report_qweb_pdf_cover">OCA/reporting-engine</a> project on GitHub.</p>
438443
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
439444
</div>
440445
</div>

0 commit comments

Comments
 (0)