From e4b1171457d1332c88f9648335ad14a8ab081d17 Mon Sep 17 00:00:00 2001 From: gituser789 Date: Fri, 14 Jun 2024 08:24:20 +0000 Subject: [PATCH] deploy: f228a82ad694f2b2966789292a3e6af69e5ee884 --- .buildinfo | 2 +- _static/documentation_options.js | 2 +- genindex.html | 4 ++-- index.html | 4 ++-- intro.html | 6 +++--- py-modindex.html | 4 ++-- search.html | 4 ++-- searchindex.js | 2 +- 8 files changed, 14 insertions(+), 14 deletions(-) diff --git a/.buildinfo b/.buildinfo index 8ddf17e..16dd4c1 100644 --- a/.buildinfo +++ b/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 4f7fd2b34b656330c54c945436e8c9ff +config: e71c5beccb1d57992893b74603fe90b4 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/_static/documentation_options.js b/_static/documentation_options.js index b15f8b4..13d90ff 100644 --- a/_static/documentation_options.js +++ b/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '0.0.2', + VERSION: '0.1.0', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/genindex.html b/genindex.html index 09c23d3..130a9f4 100644 --- a/genindex.html +++ b/genindex.html @@ -3,7 +3,7 @@ - Index — kiclearance 0.0.2 documentation + Index — kiclearance 0.1.0 documentation @@ -14,7 +14,7 @@ - + diff --git a/index.html b/index.html index 4df9c92..abdbc4c 100644 --- a/index.html +++ b/index.html @@ -4,7 +4,7 @@ - Welcome to KiClearance’s documentation! — kiclearance 0.0.2 documentation + Welcome to KiClearance’s documentation! — kiclearance 0.1.0 documentation @@ -15,7 +15,7 @@ - + diff --git a/intro.html b/intro.html index 017648c..ca03e5d 100644 --- a/intro.html +++ b/intro.html @@ -4,7 +4,7 @@ - 1 Welcome to KiClearance — kiclearance 0.0.2 documentation + 1 Welcome to KiClearance — kiclearance 0.1.0 documentation @@ -15,7 +15,7 @@ - + @@ -179,7 +179,7 @@

1.5 Troubleshooting
-kiclearance.kiclearance.write_design_rule_file(clearance_table_data, folder, kicad_project_name: str, factor_inner_layers: float = 0.5, min_track_distance: float = 0.15)
+kiclearance.kiclearance.write_design_rule_file(clearance_table_data, folder, kicad_project_name: str, factor_inner_layers: float, min_track_distance: float)

Write the rules to the design rule file (your_project.kicad_dru).

A reduction factor for the inner layers can be applied, as there is less pollution, typically inner clearance can be reduced.

diff --git a/py-modindex.html b/py-modindex.html index a2ccd92..1b739f5 100644 --- a/py-modindex.html +++ b/py-modindex.html @@ -3,7 +3,7 @@ - Python Module Index — kiclearance 0.0.2 documentation + Python Module Index — kiclearance 0.1.0 documentation @@ -14,7 +14,7 @@ - + diff --git a/search.html b/search.html index 1c0c33f..c655794 100644 --- a/search.html +++ b/search.html @@ -3,7 +3,7 @@ - Search — kiclearance 0.0.2 documentation + Search — kiclearance 0.1.0 documentation @@ -15,7 +15,7 @@ - + diff --git a/searchindex.js b/searchindex.js index a74078a..dc2d9d0 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"1.1\u00a0\u00a0\u00a0Installation": [[1, "installation"]], "1.2\u00a0\u00a0\u00a0Usage": [[1, "usage"]], "1.3\u00a0\u00a0\u00a0Tips and tricks": [[1, "tips-and-tricks"]], "1.4\u00a0\u00a0\u00a0Example": [[1, "example"]], "1.5\u00a0\u00a0\u00a0Troubleshooting": [[1, "troubleshooting"]], "1\u00a0\u00a0\u00a0Welcome to KiClearance": [[1, "welcome-to-kiclearance"]], "2\u00a0\u00a0\u00a0KiClearance function documentation": [[1, "module-kiclearance.kiclearance"]], "Contents:": [[0, null]], "Indices and tables": [[0, "indices-and-tables"]], "Welcome to KiClearance\u2019s documentation!": [[0, "welcome-to-kiclearance-s-documentation"]]}, "docnames": ["index", "intro"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.todo": 2}, "filenames": ["index.rst", "intro.rst"], "indexentries": {"kiclearance.kiclearance": [[1, "module-kiclearance.kiclearance", false]], "look_for_clearance_table_file() (in module kiclearance.kiclearance)": [[1, "kiclearance.kiclearance.look_for_clearance_table_file", false]], "look_for_kicad_project() (in module kiclearance.kiclearance)": [[1, "kiclearance.kiclearance.look_for_kicad_project", false]], "module": [[1, "module-kiclearance.kiclearance", false]], "parse_excel_table() (in module kiclearance.kiclearance)": [[1, "kiclearance.kiclearance.parse_excel_table", false]], "usage() (in module kiclearance.kiclearance)": [[1, "kiclearance.kiclearance.usage", false]], "write_design_rule_file() (in module kiclearance.kiclearance)": [[1, "kiclearance.kiclearance.write_design_rule_file", false]]}, "objects": {"kiclearance": [[1, 0, 0, "-", "kiclearance"]], "kiclearance.kiclearance": [[1, 1, 1, "", "look_for_clearance_table_file"], [1, 1, 1, "", "look_for_kicad_project"], [1, 1, 1, "", "parse_excel_table"], [1, 1, 1, "", "usage"], [1, 1, 1, "", "write_design_rule_file"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:function"}, "terms": {"0": 1, "1": 0, "15": 1, "2": 0, "3": 0, "4": 0, "5": 0, "A": 1, "For": 1, "If": 1, "The": 1, "ad": 1, "add": 1, "an": 1, "appli": 1, "applic": 1, "ar": 1, "assign": 1, "automat": 1, "been": 1, "board": 1, "bottom": 1, "can": 1, "checker": 1, "circuit": 1, "class": 1, "clearanc": 1, "clearance_table_data": 1, "clearance_table_fil": 1, "clearance_table_file_nam": 1, "complet": 1, "connect": 1, "contain": 1, "convert": 1, "creat": 1, "csv": 1, "data": 1, "default": 1, "defin": 1, "design": 1, "diagram": 1, "directli": 1, "directori": 1, "displai": 1, "distanc": 1, "done": 1, "e": 1, "each": 1, "editor": 1, "either": 1, "electr": 1, "error": 1, "exampl": 0, "execut": 1, "factor": 1, "factor_inner_lay": 1, "far": 1, "file": 1, "find": 1, "float": 1, "folder": 1, "follow": 1, "format": 1, "found": 1, "from": 1, "function": 0, "further": 1, "g": 1, "gener": 1, "given": 1, "guid": 1, "ha": 1, "here": 1, "human": 1, "i": 1, "index": 0, "inner": 1, "inspect": 1, "instal": 0, "keep": 1, "kicad": 1, "kicad_dru": 1, "kicad_pro": 1, "kicad_project_nam": 1, "layer": 1, "less": 1, "linux": 1, "list": 1, "look": 1, "look_for_clearance_table_fil": [0, 1], "look_for_kicad_project": [0, 1], "m": 1, "min_track_dist": 1, "mind": 1, "minimum": 1, "mistak": 1, "mm": 1, "modul": 0, "name": 1, "navig": 1, "net": 1, "net_1": 1, "net_2": 1, "net_3": 1, "network": 1, "none": 1, "now": 1, "od": 1, "onc": 1, "onli": 1, "open": 1, "option": 1, "own": 1, "page": 0, "param": 1, "paramet": 1, "pars": 1, "parse_excel_t": [0, 1], "pcb": 1, "pip": 1, "pollut": 1, "program": 1, "project": 1, "project_nam": 1, "pypi": 1, "python": 1, "readabl": 1, "reduc": 1, "reduct": 1, "requir": 1, "rout": 1, "rule": 1, "same": 1, "search": [0, 1], "set": 1, "setup": 1, "so": 1, "standard": 1, "start": 1, "store": 1, "str": 1, "tabl": 1, "templat": 1, "termin": 1, "test": 1, "thi": 1, "through": 1, "tip": 0, "top": 1, "track": 1, "trick": 0, "troubleshoot": 0, "try": 1, "two": 1, "type": 1, "typic": 1, "us": 1, "usag": 0, "user": 1, "voltag": 1, "when": 1, "which": 1, "work": 1, "write": 1, "write_design_rule_fil": [0, 1], "xl": 1, "xlsx": 1, "you": 1, "your": 1, "your_project": 1, "yourprojectnam": 1}, "titles": ["Welcome to KiClearance\u2019s documentation!", "1 Welcome to KiClearance"], "titleterms": {"": 0, "1": 1, "2": 1, "3": 1, "4": 1, "5": 1, "content": 0, "document": [0, 1], "exampl": 1, "function": 1, "indic": 0, "instal": 1, "kiclear": [0, 1], "tabl": 0, "tip": 1, "trick": 1, "troubleshoot": 1, "usag": 1, "welcom": [0, 1]}}) \ No newline at end of file +Search.setIndex({"alltitles": {"1.1\u00a0\u00a0\u00a0Installation": [[1, "installation"]], "1.2\u00a0\u00a0\u00a0Usage": [[1, "usage"]], "1.3\u00a0\u00a0\u00a0Tips and tricks": [[1, "tips-and-tricks"]], "1.4\u00a0\u00a0\u00a0Example": [[1, "example"]], "1.5\u00a0\u00a0\u00a0Troubleshooting": [[1, "troubleshooting"]], "1\u00a0\u00a0\u00a0Welcome to KiClearance": [[1, "welcome-to-kiclearance"]], "2\u00a0\u00a0\u00a0KiClearance function documentation": [[1, "module-kiclearance.kiclearance"]], "Contents:": [[0, null]], "Indices and tables": [[0, "indices-and-tables"]], "Welcome to KiClearance\u2019s documentation!": [[0, "welcome-to-kiclearance-s-documentation"]]}, "docnames": ["index", "intro"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.todo": 2}, "filenames": ["index.rst", "intro.rst"], "indexentries": {"kiclearance.kiclearance": [[1, "module-kiclearance.kiclearance", false]], "look_for_clearance_table_file() (in module kiclearance.kiclearance)": [[1, "kiclearance.kiclearance.look_for_clearance_table_file", false]], "look_for_kicad_project() (in module kiclearance.kiclearance)": [[1, "kiclearance.kiclearance.look_for_kicad_project", false]], "module": [[1, "module-kiclearance.kiclearance", false]], "parse_excel_table() (in module kiclearance.kiclearance)": [[1, "kiclearance.kiclearance.parse_excel_table", false]], "usage() (in module kiclearance.kiclearance)": [[1, "kiclearance.kiclearance.usage", false]], "write_design_rule_file() (in module kiclearance.kiclearance)": [[1, "kiclearance.kiclearance.write_design_rule_file", false]]}, "objects": {"kiclearance": [[1, 0, 0, "-", "kiclearance"]], "kiclearance.kiclearance": [[1, 1, 1, "", "look_for_clearance_table_file"], [1, 1, 1, "", "look_for_kicad_project"], [1, 1, 1, "", "parse_excel_table"], [1, 1, 1, "", "usage"], [1, 1, 1, "", "write_design_rule_file"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:function"}, "terms": {"0": 1, "1": 0, "2": 0, "3": 0, "4": 0, "5": 0, "A": 1, "For": 1, "If": 1, "The": 1, "ad": 1, "add": 1, "an": 1, "appli": 1, "applic": 1, "ar": 1, "assign": 1, "automat": 1, "been": 1, "board": 1, "bottom": 1, "can": 1, "checker": 1, "circuit": 1, "class": 1, "clearanc": 1, "clearance_table_data": 1, "clearance_table_fil": 1, "clearance_table_file_nam": 1, "complet": 1, "connect": 1, "contain": 1, "convert": 1, "creat": 1, "csv": 1, "data": 1, "default": 1, "defin": 1, "design": 1, "diagram": 1, "directli": 1, "directori": 1, "displai": 1, "distanc": 1, "done": 1, "e": 1, "each": 1, "editor": 1, "either": 1, "electr": 1, "error": 1, "exampl": 0, "execut": 1, "factor": 1, "factor_inner_lay": 1, "far": 1, "file": 1, "find": 1, "float": 1, "folder": 1, "follow": 1, "format": 1, "found": 1, "from": 1, "function": 0, "further": 1, "g": 1, "gener": 1, "given": 1, "guid": 1, "ha": 1, "here": 1, "human": 1, "i": 1, "index": 0, "inner": 1, "inspect": 1, "instal": 0, "keep": 1, "kicad": 1, "kicad_dru": 1, "kicad_pro": 1, "kicad_project_nam": 1, "layer": 1, "less": 1, "linux": 1, "list": 1, "look": 1, "look_for_clearance_table_fil": [0, 1], "look_for_kicad_project": [0, 1], "m": 1, "min_track_dist": 1, "mind": 1, "minimum": 1, "mistak": 1, "mm": 1, "modul": 0, "name": 1, "navig": 1, "net": 1, "net_1": 1, "net_2": 1, "net_3": 1, "network": 1, "none": 1, "now": 1, "od": 1, "onc": 1, "onli": 1, "open": 1, "option": 1, "own": 1, "page": 0, "param": 1, "paramet": 1, "pars": 1, "parse_excel_t": [0, 1], "pcb": 1, "pip": 1, "pollut": 1, "program": 1, "project": 1, "project_nam": 1, "pypi": 1, "python": 1, "readabl": 1, "reduc": 1, "reduct": 1, "requir": 1, "rout": 1, "rule": 1, "same": 1, "search": [0, 1], "set": 1, "setup": 1, "so": 1, "standard": 1, "start": 1, "store": 1, "str": 1, "tabl": 1, "templat": 1, "termin": 1, "test": 1, "thi": 1, "through": 1, "tip": 0, "top": 1, "track": 1, "trick": 0, "troubleshoot": 0, "try": 1, "two": 1, "type": 1, "typic": 1, "us": 1, "usag": 0, "user": 1, "voltag": 1, "when": 1, "which": 1, "work": 1, "write": 1, "write_design_rule_fil": [0, 1], "xl": 1, "xlsx": 1, "you": 1, "your": 1, "your_project": 1, "yourprojectnam": 1}, "titles": ["Welcome to KiClearance\u2019s documentation!", "1 Welcome to KiClearance"], "titleterms": {"": 0, "1": 1, "2": 1, "3": 1, "4": 1, "5": 1, "content": 0, "document": [0, 1], "exampl": 1, "function": 1, "indic": 0, "instal": 1, "kiclear": [0, 1], "tabl": 0, "tip": 1, "trick": 1, "troubleshoot": 1, "usag": 1, "welcom": [0, 1]}}) \ No newline at end of file