[DOCs] Added various mentions about the `resources_dir` variable

This commit is contained in:
Salvador E. Tropea 2023-04-05 07:53:13 -03:00
parent 58417e428d
commit f9c45899e4
17 changed files with 94 additions and 36 deletions

View File

@ -2194,6 +2194,7 @@ Notes:
* Type: `dxf`
* Description: Exports the PCB to 2D mechanical EDA tools (like AutoCAD).
This output is what you get from the File/Plot menu in pcbnew.
If you use custom fonts and/or colors please consult the `resources_dir` global variable.
* Valid keys:
- **`comment`**: [string=''] A comment for documentation purposes. It helps to identify the output.
- **`dir`**: [string='./'] Output directory for the generated files.
@ -2265,6 +2266,7 @@ Notes:
* Type: `dxf_sch_print`
* Description: Exports the schematic to a format commonly used for CAD software.
This output is what you get from the 'File/Plot' menu in eeschema.
If you use custom fonts and/or colors please consult the `resources_dir` global variable.
* Valid keys:
- **`comment`**: [string=''] A comment for documentation purposes. It helps to identify the output.
- **`dir`**: [string='./'] Output directory for the generated files.
@ -2440,6 +2442,7 @@ Notes:
* Type: `gerber`
* Description: This is the main fabrication format for the PCB.
This output is what you get from the File/Plot menu in pcbnew.
If you use custom fonts and/or colors please consult the `resources_dir` global variable.
* Valid keys:
- **`comment`**: [string=''] A comment for documentation purposes. It helps to identify the output.
- **`dir`**: [string='./'] Output directory for the generated files.
@ -2513,6 +2516,7 @@ Notes:
* Type: `hpgl`
* Description: Exports the PCB for plotters and laser printers.
This output is what you get from the File/Plot menu in pcbnew.
If you use custom fonts and/or colors please consult the `resources_dir` global variable.
* Valid keys:
- **`comment`**: [string=''] A comment for documentation purposes. It helps to identify the output.
- **`dir`**: [string='./'] Output directory for the generated files.
@ -2584,6 +2588,7 @@ Notes:
* Type: `hpgl_sch_print`
* Description: Exports the schematic to the most common plotter format.
This output is what you get from the 'File/Plot' menu in eeschema.
If you use custom fonts and/or colors please consult the `resources_dir` global variable.
* Valid keys:
- **`comment`**: [string=''] A comment for documentation purposes. It helps to identify the output.
- **`dir`**: [string='./'] Output directory for the generated files.
@ -3440,8 +3445,7 @@ Notes:
* Type: `pcb_print`
* Description: Prints the PCB using a mechanism that is more flexible than `pdf_pcb_print` and `svg_pcb_print`.
Supports PDF, SVG, PNG, EPS and PS formats.
KiCad 5: including the frame is slow.
KiCad 6: for custom frames use the `enable_ki6_frame_fix`, is slow.
If you use custom fonts and/or colors please consult the `resources_dir` global variable.
* Valid keys:
- **`comment`**: [string=''] A comment for documentation purposes. It helps to identify the output.
- **`dir`**: [string='./'] Output directory for the generated files.
@ -3725,6 +3729,7 @@ Notes:
Note that this output isn't the best for documating your project.
This output is what you get from the File/Plot menu in pcbnew.
The `pcb_print` is usually a better alternative.
If you use custom fonts and/or colors please consult the `resources_dir` global variable.
* Valid keys:
- **`comment`**: [string=''] A comment for documentation purposes. It helps to identify the output.
- **`dir`**: [string='./'] Output directory for the generated files.
@ -3831,6 +3836,7 @@ Notes:
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.
If you use custom fonts and/or colors please consult the `resources_dir` global variable.
* Valid keys:
- **`comment`**: [string=''] A comment for documentation purposes. It helps to identify the output.
- **`dir`**: [string='./'] Output directory for the generated files.
@ -3886,6 +3892,7 @@ Notes:
* Description: Exports the schematic to the most common exchange format. Suitable for printing.
This is the main format to document your schematic.
This output is what you get from the 'File/Plot' menu in eeschema.
If you use custom fonts and/or colors please consult the `resources_dir` global variable.
* Valid keys:
- **`comment`**: [string=''] A comment for documentation purposes. It helps to identify the output.
- **`dir`**: [string='./'] Output directory for the generated files.
@ -4052,6 +4059,7 @@ Notes:
* Description: Exports the PCB to a format suitable for printing.
This output is what you get from the File/Plot menu in pcbnew.
The `pcb_print` is usually a better alternative.
If you use custom fonts and/or colors please consult the `resources_dir` global variable.
* Valid keys:
- **`comment`**: [string=''] A comment for documentation purposes. It helps to identify the output.
- **`dir`**: [string='./'] Output directory for the generated files.
@ -4127,6 +4135,7 @@ Notes:
* Type: `ps_sch_print`
* Description: Exports the schematic in postscript. Suitable for printing.
This output is what you get from the 'File/Plot' menu in eeschema.
If you use custom fonts and/or colors please consult the `resources_dir` global variable.
* Valid keys:
- **`comment`**: [string=''] A comment for documentation purposes. It helps to identify the output.
- **`dir`**: [string='./'] Output directory for the generated files.
@ -4531,6 +4540,7 @@ Notes:
Unlike bitmaps SVG drawings can be scaled without losing resolution.
This output is what you get from the File/Plot menu in pcbnew.
The `pcb_print` is usually a better alternative.
If you use custom fonts and/or colors please consult the `resources_dir` global variable.
* Valid keys:
- **`comment`**: [string=''] A comment for documentation purposes. It helps to identify the output.
- **`dir`**: [string='./'] Output directory for the generated files.
@ -4620,6 +4630,7 @@ Notes:
* Description: 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.
If you use custom fonts and/or colors please consult the `resources_dir` global variable.
* Valid keys:
- **`comment`**: [string=''] A comment for documentation purposes. It helps to identify the output.
- **`dir`**: [string='./'] Output directory for the generated files.
@ -4677,6 +4688,7 @@ Notes:
* 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.
If you use custom fonts and/or colors please consult the `resources_dir` global variable.
* Valid keys:
- **`comment`**: [string=''] A comment for documentation purposes. It helps to identify the output.
- **`dir`**: [string='./'] Output directory for the generated files.

View File

@ -773,6 +773,7 @@ outputs:
variant: ''
# DXF (Drawing Exchange Format):
# This output is what you get from the File/Plot menu in pcbnew.
# If you use custom fonts and/or colors please consult the `resources_dir` global variable.
- name: 'dxf_example'
comment: 'Exports the PCB to 2D mechanical EDA tools (like AutoCAD).'
type: 'dxf'
@ -846,6 +847,7 @@ outputs:
layers: all
# DXF Schematic Print (Drawing Exchange Format):
# This output is what you get from the 'File/Plot' menu in eeschema.
# If you use custom fonts and/or colors please consult the `resources_dir` global variable.
- name: 'dxf_sch_print_example'
comment: 'Exports the schematic to a format commonly used for CAD software.'
type: 'dxf_sch_print'
@ -996,6 +998,7 @@ outputs:
variant: ''
# Gerber format:
# This output is what you get from the File/Plot menu in pcbnew.
# If you use custom fonts and/or colors please consult the `resources_dir` global variable.
- name: 'gerber_example'
comment: 'This is the main fabrication format for the PCB.'
type: 'gerber'
@ -1074,6 +1077,7 @@ outputs:
layers: all
# HPGL (Hewlett & Packard Graphics Language):
# This output is what you get from the File/Plot menu in pcbnew.
# If you use custom fonts and/or colors please consult the `resources_dir` global variable.
- name: 'hpgl_example'
comment: 'Exports the PCB for plotters and laser printers.'
type: 'hpgl'
@ -1148,6 +1152,7 @@ outputs:
layers: all
# HPGL Schematic Print (Hewlett & Packard Graphics Language):
# This output is what you get from the 'File/Plot' menu in eeschema.
# If you use custom fonts and/or colors please consult the `resources_dir` global variable.
- name: 'hpgl_sch_print_example'
comment: 'Exports the schematic to the most common plotter format.'
type: 'hpgl_sch_print'
@ -2120,8 +2125,7 @@ outputs:
variant: ''
# PCB Print:
# Supports PDF, SVG, PNG, EPS and PS formats.
# KiCad 5: including the frame is slow.
# KiCad 6: for custom frames use the `enable_ki6_frame_fix`, is slow.
# If you use custom fonts and/or colors please consult the `resources_dir` global variable.
- name: 'pcb_print_example'
comment: 'Prints the PCB using a mechanism that is more flexible than `pdf_pcb_print` and `svg_pcb_print`.'
type: 'pcb_print'
@ -2467,6 +2471,7 @@ outputs:
# Note that this output isn't the best for documating your project.
# This output is what you get from the File/Plot menu in pcbnew.
# The `pcb_print` is usually a better alternative.
# If you use custom fonts and/or colors please consult the `resources_dir` global variable.
- name: 'pdf_example'
comment: 'Exports the PCB to the most common exchange format. Suitable for printing.'
type: 'pdf'
@ -2539,6 +2544,7 @@ outputs:
# 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.
# If you use custom fonts and/or colors please consult the `resources_dir` global variable.
- name: 'pdf_pcb_print_example'
comment: 'Exports the PCB to the most common exchange format. Suitable for printing.'
type: 'pdf_pcb_print'
@ -2585,6 +2591,7 @@ outputs:
# PDF Schematic Print (Portable Document Format):
# This is the main format to document your schematic.
# This output is what you get from the 'File/Plot' menu in eeschema.
# If you use custom fonts and/or colors please consult the `resources_dir` global variable.
- name: 'pdf_sch_print_example'
comment: 'Exports the schematic to the most common exchange format. Suitable for printing.'
type: 'pdf_sch_print'
@ -2718,6 +2725,7 @@ outputs:
# PS (Postscript):
# This output is what you get from the File/Plot menu in pcbnew.
# The `pcb_print` is usually a better alternative.
# If you use custom fonts and/or colors please consult the `resources_dir` global variable.
- name: 'ps_example'
comment: 'Exports the PCB to a format suitable for printing.'
type: 'ps'
@ -2799,6 +2807,7 @@ outputs:
layers: all
# PS Schematic Print (Postscript):
# This output is what you get from the 'File/Plot' menu in eeschema.
# If you use custom fonts and/or colors please consult the `resources_dir` global variable.
- name: 'ps_sch_print_example'
comment: 'Exports the schematic in postscript. Suitable for printing.'
type: 'ps_sch_print'
@ -3175,6 +3184,7 @@ outputs:
# Unlike bitmaps SVG drawings can be scaled without losing resolution.
# This output is what you get from the File/Plot menu in pcbnew.
# The `pcb_print` is usually a better alternative.
# If you use custom fonts and/or colors please consult the `resources_dir` global variable.
- name: 'svg_example'
comment: 'Exports the PCB to a format suitable for 2D graphics software.'
type: 'svg'
@ -3272,6 +3282,7 @@ outputs:
# 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.
# If you use custom fonts and/or colors please consult the `resources_dir` global variable.
- name: 'svg_pcb_print_example'
comment: 'Exports the PCB to the scalable vector graphics format.'
type: 'svg_pcb_print'
@ -3322,6 +3333,7 @@ outputs:
# SVG Schematic Print:
# This is a format to document your schematic.
# This output is what you get from the 'File/Plot' menu in eeschema.
# If you use custom fonts and/or colors please consult the `resources_dir` global variable.
- name: 'svg_sch_print_example'
comment: 'Exports the schematic in a vectorized graphics format.'
type: 'svg_sch_print'

View File

@ -295,6 +295,7 @@ DISABLE_3D_MODEL_TEXT = '_Disabled_by_KiBot'
RENDERERS = ['pcbdraw', 'render_3d', 'blender_export']
PCB_GENERATORS = ['pcb_variant', 'panelize']
KIKIT_UNIT_ALIASES = {'millimeters': 'mm', 'inches': 'inch', 'mils': 'mil'}
FONT_HELP_TEXT = '\n If you use custom fonts and/or colors please consult the `resources_dir` global variable.'
class Rect(object):

View File

@ -1,12 +1,13 @@
# -*- coding: utf-8 -*-
# Copyright (c) 2020-2021 Salvador E. Tropea
# Copyright (c) 2020-2021 Instituto Nacional de Tecnología Industrial
# License: GPL-3.0
# Copyright (c) 2020-2023 Salvador E. Tropea
# Copyright (c) 2020-2023 Instituto Nacional de Tecnología Industrial
# License: AGPL-3.0
# Project: KiBot (formerly KiPlot)
from pcbnew import PLOT_FORMAT_DXF, SKETCH, FILLED
from .out_any_layer import AnyLayer
from .drill_marks import DrillMarks
from .gs import GS
from .misc import FONT_HELP_TEXT
from .macros import macros, document, output_class # noqa: F401
if GS.ki6:
from pcbnew import DXF_UNITS_MILLIMETERS, DXF_UNITS_INCHES
@ -53,6 +54,8 @@ class DXF(AnyLayer):
DXF (Drawing Exchange Format)
Exports the PCB to 2D mechanical EDA tools (like AutoCAD).
This output is what you get from the File/Plot menu in pcbnew. """
__doc__ += FONT_HELP_TEXT
def __init__(self):
super().__init__()
self._category = 'PCB/export'

View File

@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
# Copyright (c) 2020-2023 Salvador E. Tropea
# Copyright (c) 2020-2023 Instituto Nacional de Tecnología Industrial
# License: GPL-3.0
# License: AGPL-3.0
# Project: KiBot (formerly KiPlot)
"""
Dependencies:
@ -12,7 +12,7 @@ Dependencies:
"""
from .gs import GS
from .out_any_sch_print import Any_SCH_PrintOptions
from .misc import DXF_SCH_PRINT
from .misc import DXF_SCH_PRINT, FONT_HELP_TEXT
from .macros import macros, document, output_class # noqa: F401
from . import log
@ -34,6 +34,8 @@ class DXF_SCH_Print(BaseOutput): # noqa: F821
""" DXF Schematic Print (Drawing Exchange Format)
Exports the schematic to a format commonly used for CAD software.
This output is what you get from the 'File/Plot' menu in eeschema. """
__doc__ += FONT_HELP_TEXT
def __init__(self):
super().__init__()
with document:

View File

@ -2,14 +2,15 @@
# Copyright (c) 2020-2023 Salvador E. Tropea
# Copyright (c) 2020-2023 Instituto Nacional de Tecnología Industrial
# Copyright (c) 2018 John Beard
# License: GPL-3.0
# License: AGPL-3.0
# Project: KiBot (formerly KiPlot)
# Adapted from: https://github.com/johnbeard/kiplot
import os
from pcbnew import (PLOT_FORMAT_GERBER, FromMM, ToMM)
from pcbnew import PLOT_FORMAT_GERBER, FromMM, ToMM
from .gs import GS
from .misc import FONT_HELP_TEXT
from .optionable import Optionable
from .out_any_layer import (AnyLayer, AnyLayerOptions)
from .out_any_layer import AnyLayer, AnyLayerOptions
from .error import KiPlotConfigurationError
from .macros import macros, document, output_class # noqa: F401
from . import log
@ -105,6 +106,8 @@ class Gerber(AnyLayer):
""" Gerber format
This is the main fabrication format for the PCB.
This output is what you get from the File/Plot menu in pcbnew. """
__doc__ += FONT_HELP_TEXT
def __init__(self):
super().__init__()
with document:

View File

@ -1,11 +1,12 @@
# -*- coding: utf-8 -*-
# Copyright (c) 2020-2023 Salvador E. Tropea
# Copyright (c) 2020-2023 Instituto Nacional de Tecnología Industrial
# License: GPL-3.0
# License: AGPL-3.0
# Project: KiBot (formerly KiPlot)
from pcbnew import PLOT_FORMAT_HPGL, SKETCH, FILLED
from .out_any_layer import AnyLayer
from .drill_marks import DrillMarks
from .misc import FONT_HELP_TEXT
from .macros import macros, document, output_class # noqa: F401
@ -49,6 +50,8 @@ class HPGL(AnyLayer):
""" HPGL (Hewlett & Packard Graphics Language)
Exports the PCB for plotters and laser printers.
This output is what you get from the File/Plot menu in pcbnew. """
__doc__ += FONT_HELP_TEXT
def __init__(self):
super().__init__()
self._category = 'PCB/docs'

View File

@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
# Copyright (c) 2020-2023 Salvador E. Tropea
# Copyright (c) 2020-2023 Instituto Nacional de Tecnología Industrial
# License: GPL-3.0
# License: AGPL-3.0
# Project: KiBot (formerly KiPlot)
"""
Dependencies:
@ -12,7 +12,7 @@ Dependencies:
"""
from .gs import GS
from .out_any_sch_print import Any_SCH_PrintOptions
from .misc import HPGL_SCH_PRINT
from .misc import HPGL_SCH_PRINT, FONT_HELP_TEXT
from .macros import macros, document, output_class # noqa: F401
from . import log
@ -42,6 +42,8 @@ class HPGL_SCH_Print(BaseOutput): # noqa: F821
""" HPGL Schematic Print (Hewlett & Packard Graphics Language)
Exports the schematic to the most common plotter format.
This output is what you get from the 'File/Plot' menu in eeschema. """
__doc__ += FONT_HELP_TEXT
def __init__(self):
super().__init__()
with document:

View File

@ -47,7 +47,7 @@ from .kicad.config import KiConf
from .kicad.v5_sch import SchError
from .kicad.pcb import PCB
from .misc import (PDF_PCB_PRINT, W_PDMASKFAIL, W_MISSTOOL, PCBDRAW_ERR, W_PCBDRAW, VIATYPE_THROUGH, VIATYPE_BLIND_BURIED,
VIATYPE_MICROVIA)
VIATYPE_MICROVIA, FONT_HELP_TEXT)
from .create_pdf import create_pdf_from_pages
from .macros import macros, document, output_class # noqa: F401
from .drill_marks import DRILL_MARKS_MAP, add_drill_marks
@ -1212,9 +1212,9 @@ class PCB_PrintOptions(VariantOptions):
class PCB_Print(BaseOutput): # noqa: F821
""" PCB Print
Prints the PCB using a mechanism that is more flexible than `pdf_pcb_print` and `svg_pcb_print`.
Supports PDF, SVG, PNG, EPS and PS formats.
KiCad 5: including the frame is slow.
KiCad 6: for custom frames use the `enable_ki6_frame_fix`, is slow. """
Supports PDF, SVG, PNG, EPS and PS formats. """
__doc__ += FONT_HELP_TEXT
def __init__(self):
super().__init__()
with document:

View File

@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
# Copyright (c) 2020 Salvador E. Tropea
# Copyright (c) 2020 Instituto Nacional de Tecnología Industrial
# Copyright (c) 2020-2023 Salvador E. Tropea
# Copyright (c) 2020-2023 Instituto Nacional de Tecnología Industrial
# Copyright (c) 2018 John Beard
# License: GPL-3.0
# Project: KiBot (formerly KiPlot)
@ -9,6 +9,7 @@ from pcbnew import (PLOT_FORMAT_PDF, FromMM, ToMM)
from .out_any_layer import AnyLayer
from .drill_marks import DrillMarks
from .gs import GS
from .misc import FONT_HELP_TEXT
from .macros import macros, document, output_class # noqa: F401
from . import log
@ -49,6 +50,8 @@ class PDF(AnyLayer, DrillMarks):
Note that this output isn't the best for documating your project.
This output is what you get from the File/Plot menu in pcbnew.
The `pcb_print` is usually a better alternative. """
__doc__ += FONT_HELP_TEXT
def __init__(self):
super().__init__()
with document:

View File

@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
# Copyright (c) 2020-2022 Salvador E. Tropea
# Copyright (c) 2020-2022 Instituto Nacional de Tecnología Industrial
# License: GPL-3.0
# Copyright (c) 2020-2023 Salvador E. Tropea
# Copyright (c) 2020-2023 Instituto Nacional de Tecnología Industrial
# License: AGPL-3.0
# Project: KiBot (formerly KiPlot)
"""
Dependencies:
@ -12,6 +12,7 @@ Dependencies:
from .gs import GS
from .out_any_pcb_print import Any_PCB_PrintOptions
from .error import KiPlotConfigurationError
from .misc import FONT_HELP_TEXT
from .macros import macros, document, output_class # noqa: F401
from .layer import Layer
from . import log
@ -35,6 +36,8 @@ class PDF_PCB_Print(BaseOutput): # noqa: F821
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. """
__doc__ += FONT_HELP_TEXT
def __init__(self):
super().__init__()
with document:

View File

@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
# Copyright (c) 2020-2023 Salvador E. Tropea
# Copyright (c) 2020-2023 Instituto Nacional de Tecnología Industrial
# License: GPL-3.0
# License: AGPL-3.0
# Project: KiBot (formerly KiPlot)
"""
Dependencies:
@ -12,7 +12,7 @@ Dependencies:
"""
from .gs import GS
from .out_any_sch_print import Any_SCH_PrintOptions
from .misc import PDF_SCH_PRINT
from .misc import PDF_SCH_PRINT, FONT_HELP_TEXT
from .macros import macros, document, output_class # noqa: F401
from . import log
@ -35,6 +35,8 @@ class PDF_SCH_Print(BaseOutput): # noqa: F821
Exports the schematic to the most common exchange format. Suitable for printing.
This is the main format to document your schematic.
This output is what you get from the 'File/Plot' menu in eeschema. """
__doc__ += FONT_HELP_TEXT
def __init__(self):
super().__init__()
with document:

View File

@ -2,12 +2,13 @@
# Copyright (c) 2020-2023 Salvador E. Tropea
# Copyright (c) 2020-2023 Instituto Nacional de Tecnología Industrial
# Copyright (c) 2018 John Beard
# License: GPL-3.0
# License: AGPL-3.0
# Project: KiBot (formerly KiPlot)
# Adapted from: https://github.com/johnbeard/kiplot
from pcbnew import PLOT_FORMAT_POST, FromMM, ToMM, SKETCH, FILLED
from .out_any_layer import AnyLayer
from .drill_marks import DrillMarks
from .misc import FONT_HELP_TEXT
from .gs import GS
from .macros import macros, document, output_class # noqa: F401
@ -66,6 +67,8 @@ class PS(AnyLayer):
Exports the PCB to a format suitable for printing.
This output is what you get from the File/Plot menu in pcbnew.
The `pcb_print` is usually a better alternative. """
__doc__ += FONT_HELP_TEXT
def __init__(self):
super().__init__()
with document:

View File

@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
# Copyright (c) 2020-2023 Salvador E. Tropea
# Copyright (c) 2020-2023 Instituto Nacional de Tecnología Industrial
# License: GPL-3.0
# License: AGPL-3.0
# Project: KiBot (formerly KiPlot)
"""
Dependencies:
@ -12,7 +12,7 @@ Dependencies:
"""
from .gs import GS
from .out_any_sch_print import Any_SCH_PrintOptions
from .misc import PS_SCH_PRINT
from .misc import PS_SCH_PRINT, FONT_HELP_TEXT
from .macros import macros, document, output_class # noqa: F401
from . import log
@ -34,6 +34,8 @@ class PS_SCH_Print(BaseOutput): # noqa: F821
""" PS Schematic Print (Postscript)
Exports the schematic in postscript. Suitable for printing.
This output is what you get from the 'File/Plot' menu in eeschema. """
__doc__ += FONT_HELP_TEXT
def __init__(self):
super().__init__()
with document:

View File

@ -2,7 +2,7 @@
# Copyright (c) 2020-2023 Salvador E. Tropea
# Copyright (c) 2020-2023 Instituto Nacional de Tecnología Industrial
# Copyright (c) 2018 John Beard
# License: GPL-3.0
# License: AGPL-3.0
# Project: KiBot (formerly KiPlot)
# Adapted from: https://github.com/johnbeard/kiplot
import os
@ -10,7 +10,7 @@ from pcbnew import PLOT_FORMAT_SVG, FromMM, ToMM
from .drill_marks import DrillMarks
from .gs import GS
from .kicad.patch_svg import change_svg_viewbox
from .misc import W_ESCINV
from .misc import W_ESCINV, FONT_HELP_TEXT
from .out_base import PcbMargin
from .out_any_layer import AnyLayer
from .macros import macros, document, output_class # noqa: F401
@ -100,6 +100,8 @@ class SVG(AnyLayer):
Unlike bitmaps SVG drawings can be scaled without losing resolution.
This output is what you get from the File/Plot menu in pcbnew.
The `pcb_print` is usually a better alternative. """
__doc__ += FONT_HELP_TEXT
def __init__(self):
super().__init__()
with document:

View File

@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
# Copyright (c) 2020-2022 Salvador E. Tropea
# Copyright (c) 2020-2022 Instituto Nacional de Tecnología Industrial
# License: GPL-3.0
# Copyright (c) 2020-2023 Salvador E. Tropea
# Copyright (c) 2020-2023 Instituto Nacional de Tecnología Industrial
# License: AGPL-3.0
# Project: KiBot (formerly KiPlot)
"""
Dependencies:
@ -15,6 +15,7 @@ from .out_any_pcb_print import Any_PCB_PrintOptions
from .error import KiPlotConfigurationError
from .kicad.patch_svg import patch_svg_file
from .kicad.pcb import PCB
from .misc import FONT_HELP_TEXT
from .macros import macros, document, output_class # noqa: F401
from .layer import Layer
from . import log
@ -51,6 +52,8 @@ class SVG_PCB_Print(BaseOutput): # noqa: F821
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. """
__doc__ += FONT_HELP_TEXT
def __init__(self):
super().__init__()
with document:

View File

@ -2,7 +2,7 @@
# Copyright (c) 2020-2023 Salvador E. Tropea
# Copyright (c) 2020-2023 Instituto Nacional de Tecnología Industrial
# Copyright (c) 2020 @nerdyscout
# License: GPL-3.0
# License: AGPL-3.0
# Project: KiBot (formerly KiPlot)
"""
Dependencies:
@ -13,7 +13,7 @@ Dependencies:
"""
from .gs import GS
from .out_any_sch_print import Any_SCH_PrintOptions
from .misc import SVG_SCH_PRINT
from .misc import SVG_SCH_PRINT, FONT_HELP_TEXT
from .macros import macros, document, output_class # noqa: F401
from . import log
@ -36,6 +36,8 @@ class SVG_SCH_Print(BaseOutput): # noqa: F821
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. """
__doc__ += FONT_HELP_TEXT
def __init__(self):
super().__init__()
with document: