[DOCs] Added more clarification to the print outputs
- Marked PDF/SVG PCB Print as deprecated. They work even worst on KiCad 7 and the problems are OS dependent. - Made clear that "SVG Schematic Print" is a "Plot" - Updated dependencies
This commit is contained in:
Salvador E. Tropea
parent
fe26f1ab6a
commit
453d3482fe
11
README.md
11
README.md
|
|
@ -136,10 +136,10 @@ Notes:
|
|||
[**Requests**](https://pypi.org/project/Requests/) [](https://pypi.org/project/Requests/) [](https://pypi.org/project/Requests/) [](https://packages.debian.org/bullseye/python3-requests)
|
||||
- Mandatory
|
||||
|
||||
[**KiCad Automation tools**](https://github.com/INTI-CMNB/KiAuto) v2.1.1 [](https://github.com/INTI-CMNB/KiAuto) 
|
||||
[**KiCad Automation tools**](https://github.com/INTI-CMNB/KiAuto) v2.2.0 [](https://github.com/INTI-CMNB/KiAuto) 
|
||||
- Mandatory for: `dxf_sch_print`, `gencad`, `hpgl_sch_print`, `netlist`, `pdf_pcb_print`, `pdf_sch_print`, `ps_sch_print`, `render_3d`, `run_drc`, `run_erc`, `step`, `svg_pcb_print`, `svg_sch_print`, `update_xml`, `vrml`
|
||||
- Optional to:
|
||||
- Compare schematics for `diff` (v2.0.0)
|
||||
- Compare schematics for `diff` (v2.2.0)
|
||||
- Show KiAuto installation information for `info` (v2.0.0)
|
||||
- Print the page frame in GUI mode for `pcb_print` (v1.6.7)
|
||||
|
||||
|
|
@ -172,7 +172,7 @@ Notes:
|
|||
[**KiBoM**](https://github.com/INTI-CMNB/KiBoM) v1.8.0 [](https://github.com/INTI-CMNB/KiBoM) 
|
||||
- Mandatory for `kibom`
|
||||
|
||||
[**KiCad PCB/SCH Diff**](https://github.com/INTI-CMNB/KiDiff) v2.4.3 [](https://github.com/INTI-CMNB/KiDiff) 
|
||||
[**KiCad PCB/SCH Diff**](https://github.com/INTI-CMNB/KiDiff) v2.4.4 [](https://github.com/INTI-CMNB/KiDiff) 
|
||||
- Mandatory for `diff`
|
||||
|
||||
[**markdown2**](https://pypi.org/project/markdown2/) [](https://pypi.org/project/markdown2/) [](https://pypi.org/project/markdown2/) [](https://packages.debian.org/bullseye/python3-markdown2)
|
||||
|
|
@ -3779,7 +3779,7 @@ Notes:
|
|||
- `uppercase_extensions`: [boolean=false] Use uppercase names for the extensions.
|
||||
- `variant`: [string=''] Board variant to apply.
|
||||
|
||||
* PDF PCB Print (Portable Document Format)
|
||||
* PDF PCB Print (Portable Document Format) *Deprecated*
|
||||
* Type: `pdf_pcb_print`
|
||||
* Description: Exports the PCB to the most common exchange format. Suitable for printing.
|
||||
This is the main format to document your PCB.
|
||||
|
|
@ -4559,7 +4559,7 @@ Notes:
|
|||
Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
|
||||
- `run_by_default`: [boolean=true] When enabled this output will be created when no specific outputs are requested.
|
||||
|
||||
* SVG PCB Print (Scalable Vector Graphics)
|
||||
* SVG PCB Print (Scalable Vector Graphics) *Deprecated*
|
||||
* Type: `svg_pcb_print`
|
||||
* Description: Exports the PCB to the scalable vector graphics format.
|
||||
This output is what you get from the 'File/Print' menu in pcbnew.
|
||||
|
|
@ -4620,6 +4620,7 @@ Notes:
|
|||
* Type: `svg_sch_print`
|
||||
* Description: Exports the schematic in a vectorized graphics format.
|
||||
This is a format to document your schematic.
|
||||
This output is what you get from the 'File/Plot' menu in eeschema.
|
||||
* Valid keys:
|
||||
- **`comment`**: [string=''] A comment for documentation purposes. It helps to identify the output.
|
||||
- **`dir`**: [string='./'] Output directory for the generated files.
|
||||
|
|
|
|||
|
|
@ -2511,7 +2511,7 @@ outputs:
|
|||
# [string=''] Board variant to apply
|
||||
variant: ''
|
||||
layers: all
|
||||
# PDF PCB Print (Portable Document Format):
|
||||
# PDF PCB Print (Portable Document Format) *Deprecated*:
|
||||
# This is the main format to document your PCB.
|
||||
# This output is what you get from the 'File/Print' menu in pcbnew.
|
||||
# The `pcb_print` is usually a better alternative.
|
||||
|
|
@ -3230,7 +3230,7 @@ outputs:
|
|||
# [string=''] Board variant to apply
|
||||
variant: ''
|
||||
layers: all
|
||||
# SVG PCB Print (Scalable Vector Graphics):
|
||||
# SVG PCB Print (Scalable Vector Graphics) *Deprecated*:
|
||||
# This output is what you get from the 'File/Print' menu in pcbnew.
|
||||
# The `pcb_print` is usually a better alternative.
|
||||
- name: 'svg_pcb_print_example'
|
||||
|
|
@ -3282,6 +3282,7 @@ outputs:
|
|||
layers: all
|
||||
# SVG Schematic Print:
|
||||
# This is a format to document your schematic.
|
||||
# This output is what you get from the 'File/Plot' menu in eeschema.
|
||||
- name: 'svg_sch_print_example'
|
||||
comment: 'Exports the schematic in a vectorized graphics format.'
|
||||
type: 'svg_sch_print'
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ class PDF_PCB_PrintOptions(Any_PCB_PrintOptions):
|
|||
|
||||
@output_class
|
||||
class PDF_PCB_Print(BaseOutput): # noqa: F821
|
||||
""" PDF PCB Print (Portable Document Format)
|
||||
""" PDF PCB Print (Portable Document Format) *Deprecated*
|
||||
Exports the PCB to the most common exchange format. Suitable for printing.
|
||||
This is the main format to document your PCB.
|
||||
This output is what you get from the 'File/Print' menu in pcbnew.
|
||||
|
|
|
|||
|
|
@ -47,7 +47,7 @@ class SVG_PCB_PrintOptions(Any_PCB_PrintOptions):
|
|||
|
||||
@output_class
|
||||
class SVG_PCB_Print(BaseOutput): # noqa: F821
|
||||
""" SVG PCB Print (Scalable Vector Graphics)
|
||||
""" SVG PCB Print (Scalable Vector Graphics) *Deprecated*
|
||||
Exports the PCB to the scalable vector graphics format.
|
||||
This output is what you get from the 'File/Print' menu in pcbnew.
|
||||
The `pcb_print` is usually a better alternative. """
|
||||
|
|
|
|||
|
|
@ -34,7 +34,8 @@ class SVG_SCH_PrintOptions(Any_SCH_PrintOptions):
|
|||
class SVG_SCH_Print(BaseOutput): # noqa: F821
|
||||
""" SVG Schematic Print
|
||||
Exports the schematic in a vectorized graphics format.
|
||||
This is a format to document your schematic. """
|
||||
This is a format to document your schematic.
|
||||
This output is what you get from the 'File/Plot' menu in eeschema. """
|
||||
def __init__(self):
|
||||
super().__init__()
|
||||
with document:
|
||||
|
|
|
|||
|
|
@ -409,7 +409,7 @@ deps = '{\
|
|||
"output": "diff",\
|
||||
"version": [\
|
||||
2,\
|
||||
0,\
|
||||
2,\
|
||||
0\
|
||||
]\
|
||||
},\
|
||||
|
|
@ -634,7 +634,7 @@ deps = '{\
|
|||
"version": [\
|
||||
2,\
|
||||
4,\
|
||||
3\
|
||||
4\
|
||||
]\
|
||||
}\
|
||||
],\
|
||||
|
|
|
|||
Loading…
Reference in New Issue