├── .editorconfig
├── .github
    └── ISSUE_TEMPLATE.md
├── .gitignore
├── .nojekyll
├── .travis.yml
├── AUTHORS.rst
├── CONTRIBUTING.rst
├── HISTORY.rst
├── LICENSE
├── MANIFEST.in
├── Makefile
├── README.rst
├── docs
    ├── Makefile
    ├── _build
    │   └── singlehtml
    │   │   ├── _static
    │   │       ├── ajax-loader.gif
    │   │       ├── alabaster.css
    │   │       ├── basic.css
    │   │       ├── comment-bright.png
    │   │       ├── comment-close.png
    │   │       ├── comment.png
    │   │       ├── custom.css
    │   │       ├── doctools.js
    │   │       ├── documentation_options.js
    │   │       ├── down-pressed.png
    │   │       ├── down.png
    │   │       ├── file.png
    │   │       ├── jquery-3.2.1.js
    │   │       ├── jquery.js
    │   │       ├── language_data.js
    │   │       ├── minus.png
    │   │       ├── plus.png
    │   │       ├── pygments.css
    │   │       ├── searchtools.js
    │   │       ├── underscore-1.3.1.js
    │   │       ├── underscore.js
    │   │       ├── up-pressed.png
    │   │       ├── up.png
    │   │       └── websupport.js
    │   │   └── index.html
    ├── authors.rst
    ├── conf.py
    ├── contributing.rst
    ├── history.rst
    ├── index.rst
    ├── installation.rst
    ├── make.bat
    ├── readme.rst
    └── usage.rst
├── index.html
├── kinet2pcb
    ├── __init__.py
    ├── kinet2pcb.py
    └── pckg_info.py
├── notes.txt
├── publish.sh
├── requirements_dev.txt
├── setup.cfg
├── setup.py
├── tests
    ├── conftest.py
    ├── kinet2pcb_test
    │   ├── kinet2pcb_test.net
    │   ├── kinet2pcb_test.pro
    │   └── kinet2pcb_test.sch
    └── test_kinet2pcb.py
└── tox.ini


/.editorconfig:
--------------------------------------------------------------------------------
 1 | # http://editorconfig.org
 2 | 
 3 | root = true
 4 | 
 5 | [*]
 6 | indent_style = space
 7 | indent_size = 4
 8 | trim_trailing_whitespace = true
 9 | insert_final_newline = true
10 | charset = utf-8
11 | end_of_line = lf
12 | 
13 | [*.bat]
14 | indent_style = tab
15 | end_of_line = crlf
16 | 
17 | [LICENSE]
18 | insert_final_newline = false
19 | 
20 | [Makefile]
21 | indent_style = tab
22 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE.md:
--------------------------------------------------------------------------------
 1 | * kinet2pcb version:
 2 | * Python version:
 3 | * Operating System:
 4 | 
 5 | ### Description
 6 | 
 7 | Describe what you were trying to get done.
 8 | Tell us what happened, what went wrong, and what you expected to happen.
 9 | 
10 | ### What I Did
11 | 
12 | ```
13 | Paste the command(s) you ran and the output.
14 | If there was a crash, please include the traceback here.
15 | ```
16 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
  1 | # Byte-compiled / optimized / DLL files
  2 | __pycache__/
  3 | *.py[cod]
  4 | *$py.class
  5 | 
  6 | # C extensions
  7 | *.so
  8 | 
  9 | # Distribution / packaging
 10 | .Python
 11 | env/
 12 | build/
 13 | develop-eggs/
 14 | dist/
 15 | downloads/
 16 | eggs/
 17 | .eggs/
 18 | lib/
 19 | lib64/
 20 | parts/
 21 | sdist/
 22 | var/
 23 | wheels/
 24 | *.egg-info/
 25 | .installed.cfg
 26 | *.egg
 27 | 
 28 | # PyInstaller
 29 | #  Usually these files are written by a python script from a template
 30 | #  before PyInstaller builds the exe, so as to inject date/other infos into it.
 31 | *.manifest
 32 | *.spec
 33 | 
 34 | # Installer logs
 35 | pip-log.txt
 36 | pip-delete-this-directory.txt
 37 | 
 38 | # Unit test / coverage reports
 39 | htmlcov/
 40 | .tox/
 41 | .coverage
 42 | .coverage.*
 43 | .cache
 44 | nosetests.xml
 45 | coverage.xml
 46 | *.cover
 47 | .hypothesis/
 48 | .pytest_cache/
 49 | 
 50 | # Translations
 51 | *.mo
 52 | *.pot
 53 | 
 54 | # Django stuff:
 55 | *.log
 56 | local_settings.py
 57 | 
 58 | # Flask stuff:
 59 | instance/
 60 | .webassets-cache
 61 | 
 62 | # Scrapy stuff:
 63 | .scrapy
 64 | 
 65 | # Sphinx documentation
 66 | docs/_build/
 67 | 
 68 | # PyBuilder
 69 | target/
 70 | 
 71 | # Jupyter Notebook
 72 | .ipynb_checkpoints
 73 | 
 74 | # pyenv
 75 | .python-version
 76 | 
 77 | # celery beat schedule file
 78 | celerybeat-schedule
 79 | 
 80 | # SageMath parsed files
 81 | *.sage.py
 82 | 
 83 | # dotenv
 84 | .env
 85 | 
 86 | # virtualenv
 87 | .venv
 88 | venv/
 89 | ENV/
 90 | 
 91 | # Spyder project settings
 92 | .spyderproject
 93 | .spyproject
 94 | 
 95 | # Rope project settings
 96 | .ropeproject
 97 | 
 98 | # mkdocs documentation
 99 | /site
100 | 
101 | # mypy
102 | .mypy_cache/
103 | 


--------------------------------------------------------------------------------
/.nojekyll:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/devbisme/kinet2pcb/1ccad5d6df308126427aa7c3d0eafa693386e230/.nojekyll


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
 1 | # Config file for automatic testing at travis-ci.org
 2 | 
 3 | language: python
 4 | python:
 5 |   - 3.6
 6 |   - 3.5
 7 |   - 3.4
 8 |   - 2.7
 9 | 
10 | # Command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
11 | install: pip install -U tox-travis
12 | 
13 | # Command to run tests, e.g. python setup.py test
14 | script: tox
15 | 
16 | 
17 | 


--------------------------------------------------------------------------------
/AUTHORS.rst:
--------------------------------------------------------------------------------
 1 | =======
 2 | Credits
 3 | =======
 4 | 
 5 | Development Lead
 6 | ----------------
 7 | 
 8 | * Dave Vandenbout <devb@xess.com>
 9 | 
10 | `Other Contributors <https://github.com/devbisme/kinet2pcb/graphs/contributors>`_
11 | ---------------------------------------------------------------------------------
12 | 


--------------------------------------------------------------------------------
/CONTRIBUTING.rst:
--------------------------------------------------------------------------------
 1 | .. highlight:: shell
 2 | 
 3 | ============
 4 | Contributing
 5 | ============
 6 | 
 7 | Contributions are welcome, and they are greatly appreciated! Every little bit
 8 | helps, and credit will always be given.
 9 | 
10 | You can contribute in many ways:
11 | 
12 | Types of Contributions
13 | ----------------------
14 | 
15 | Report Bugs
16 | ~~~~~~~~~~~
17 | 
18 | Report bugs at https://github.com/devbisme/kinet2pcb/issues.
19 | 
20 | If you are reporting a bug, please include:
21 | 
22 | * Your operating system name and version.
23 | * Any details about your local setup that might be helpful in troubleshooting.
24 | * Detailed steps to reproduce the bug.
25 | 
26 | Fix Bugs
27 | ~~~~~~~~
28 | 
29 | Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
30 | wanted" is open to whoever wants to implement it.
31 | 
32 | Implement Features
33 | ~~~~~~~~~~~~~~~~~~
34 | 
35 | Look through the GitHub issues for features. Anything tagged with "enhancement"
36 | and "help wanted" is open to whoever wants to implement it.
37 | 
38 | Write Documentation
39 | ~~~~~~~~~~~~~~~~~~~
40 | 
41 | kinet2pcb could always use more documentation, whether as part of the
42 | official kinet2pcb docs, in docstrings, or even on the web in blog posts,
43 | articles, and such.
44 | 
45 | Submit Feedback
46 | ~~~~~~~~~~~~~~~
47 | 
48 | The best way to send feedback is to file an issue at https://github.com/devbisme/kinet2pcb/issues.
49 | 
50 | If you are proposing a feature:
51 | 
52 | * Explain in detail how it would work.
53 | * Keep the scope as narrow as possible, to make it easier to implement.
54 | * Remember that this is a volunteer-driven project, and that contributions
55 |   are welcome :)
56 | 
57 | Get Started!
58 | ------------
59 | 
60 | Ready to contribute? Here's how to set up `kinet2pcb` for local development.
61 | 
62 | 1. Fork the `kinet2pcb` repo on GitHub.
63 | 2. Clone your fork locally::
64 | 
65 |     $ git clone git@github.com:your_name_here/kinet2pcb.git
66 | 
67 | 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
68 | 
69 |     $ mkvirtualenv kinet2pcb
70 |     $ cd kinet2pcb/
71 |     $ python setup.py develop
72 | 
73 | 4. Create a branch for local development::
74 | 
75 |     $ git checkout -b name-of-your-bugfix-or-feature
76 | 
77 |    Now you can make your changes locally.
78 | 
79 | 5. Commit your changes and push your branch to GitHub::
80 | 
81 |     $ git add .
82 |     $ git commit -m "Your detailed description of your changes."
83 |     $ git push origin name-of-your-bugfix-or-feature
84 | 
85 | 6. Submit a pull request through the GitHub website.
86 | 
87 | Pull Request Guidelines
88 | -----------------------
89 | 
90 | Before you submit a pull request, check that it meets these guidelines:
91 | 
92 | 1. If the pull request adds functionality, the docs should be updated. Put
93 |    your new functionality into a function with a docstring, and add the
94 |    feature to the list in README.rst.
95 | 2. The pull request should work for Python 2.7, and >=3.6
96 | 


--------------------------------------------------------------------------------
/HISTORY.rst:
--------------------------------------------------------------------------------
 1 | =======
 2 | History
 3 | =======
 4 | 
 5 | 1.1.4 (2025-11-03)
 6 | ------------------
 7 | 
 8 | * Fixed os.path.join() usage when adding KiCad paths to sys.path.
 9 | * Raise exception if KiCad installation is not found when importing pcbnew.
10 | 
11 | 
12 | 1.1.3 (2025-11-02)
13 | ------------------
14 | 
15 | * Removed dependence upon kinparse. Now using simp_sexp to parse netlist files.
16 | * More robust searching for fp-lib-table file for multiple versions of KiCad on both Windows and Linux.
17 | * Python 3.6 or higher is now required.
18 | 
19 | 
20 | 1.1.2 (2024-02-26)
21 | ------------------
22 | 
23 | * Added FPID setting to part, otherwise only the fp_name and not the fp_lib appears in the final board.
24 | * Added iterator to connect all pads of the same number to a given net. This mimics the behavior of the GUI editor.
25 | * Added Python 3.12 to test environments.
26 | 
27 | 
28 | 1.1.1 (2023-09-10)
29 | ------------------
30 | 
31 | * `net.get_pins()` is now used when a SKiDL Circuit object is used as the input for generating a PCB.
32 | 
33 | 
34 | 1.1.0 (2022-08-13)
35 | ------------------
36 | 
37 | * Added `--libraries` command-line option to specify footprint library directories.
38 | 
39 | 
40 | 1.0.1 (2022-06-30)
41 | ------------------
42 | 
43 | * Fixed incompatibilities with KiCad V6 Python API (pcbnew).
44 | 
45 | 
46 | 1.0.0 (2021-09-16)
47 | ------------------
48 | 
49 | * Decided this tool was mature to the point it could be called 1.0.0.
50 | 
51 | 
52 | 0.1.3 (2021-05-19)
53 | ------------------
54 | 
55 | * The parts in the PCB are now given a non-overlapping arrangement
56 |   grouped according to their hierarchical nesting.
57 | 
58 | 
59 | 0.1.2 (2021-05-18)
60 | ------------------
61 | 
62 | * The ``kinet2pcb()`` function will now generate a KiCad PCB file when given
63 |   a netlist file name, a PyParsing object, or a SKiDL Circuit object.
64 | * ``kinet2pcb`` can now be installed in the default Python interpreter on
65 |   a system and it will look in ``/usr/lib/python3/dist-packages`` to find
66 |   the ``pcbnew`` module installed by KiCad.  If the ``pcbnew`` module
67 |   is not found there, add the correct location to the ``PYTHONPATH``
68 |   environment variable.
69 | 
70 | 
71 | 0.1.1 (2019-03-09)
72 | ------------------
73 | 
74 | * Now runs under Python 2 & 3.
75 | 
76 | 
77 | 0.1.0 (2019-10-28)
78 | ------------------
79 | 
80 | * First release on PyPI.
81 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2019-2021, Dave Vandenbout.
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 
23 | 


--------------------------------------------------------------------------------
/MANIFEST.in:
--------------------------------------------------------------------------------
 1 | include AUTHORS.rst
 2 | include CONTRIBUTING.rst
 3 | include HISTORY.rst
 4 | include LICENSE
 5 | include README.rst
 6 | 
 7 | recursive-include tests *
 8 | recursive-exclude * __pycache__
 9 | recursive-exclude * *.py[co]
10 | 
11 | recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
12 | 


--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
 1 | .PHONY: clean clean-test clean-pyc clean-build docs help
 2 | .DEFAULT_GOAL := help
 3 | 
 4 | define BROWSER_PYSCRIPT
 5 | import os, webbrowser, sys
 6 | 
 7 | try:
 8 | 	from urllib import pathname2url
 9 | except:
10 | 	from urllib.request import pathname2url
11 | 
12 | webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
13 | endef
14 | export BROWSER_PYSCRIPT
15 | 
16 | define PRINT_HELP_PYSCRIPT
17 | import re, sys
18 | 
19 | for line in sys.stdin:
20 | 	match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
21 | 	if match:
22 | 		target, help = match.groups()
23 | 		print("%-20s %s" % (target, help))
24 | endef
25 | export PRINT_HELP_PYSCRIPT
26 | 
27 | BROWSER := python -c "$$BROWSER_PYSCRIPT"
28 | 
29 | help:
30 | 	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
31 | 
32 | clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
33 | 
34 | clean-build: ## remove build artifacts
35 | 	rm -fr build/
36 | 	rm -fr dist/
37 | 	rm -fr .eggs/
38 | 	find . -name '*.egg-info' -exec rm -fr {} +
39 | 	find . -name '*.egg' -exec rm -f {} +
40 | 
41 | clean-pyc: ## remove Python file artifacts
42 | 	find . -name '*.pyc' -exec rm -f {} +
43 | 	find . -name '*.pyo' -exec rm -f {} +
44 | 	find . -name '*~' -exec rm -f {} +
45 | 	find . -name '__pycache__' -exec rm -fr {} +
46 | 
47 | clean-test: ## remove test and coverage artifacts
48 | 	rm -fr .tox/
49 | 	rm -f .coverage
50 | 	rm -fr htmlcov/
51 | 	rm -fr .pytest_cache
52 | 
53 | lint: ## check style with flake8
54 | 	flake8 kinet2pcb tests
55 | 
56 | test: ## run tests quickly with the default Python
57 | 	py.test
58 | 
59 | test-all: ## run tests on every Python version with tox
60 | 	tox
61 | 
62 | coverage: ## check code coverage quickly with the default Python
63 | 	coverage run --source kinet2pcb -m pytest
64 | 	coverage report -m
65 | 	coverage html
66 | 	$(BROWSER) htmlcov/index.html
67 | 
68 | docs: ## generate Sphinx HTML documentation, including API docs
69 | 	rm -f docs/kinet2pcb.rst
70 | 	rm -f docs/modules.rst
71 | 	sphinx-apidoc -o docs/ kinet2pcb
72 | 	$(MAKE) -C docs clean
73 | 	$(MAKE) -C docs html
74 | 	$(BROWSER) docs/_build/html/index.html
75 | 
76 | servedocs: docs ## compile the docs watching for changes
77 | 	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
78 | 
79 | release: dist ## package and upload a release
80 | 	twine upload dist/*
81 | 
82 | dist: clean ## builds source and wheel package
83 | 	python setup.py sdist
84 | 	python setup.py bdist_wheel
85 | 	ls -l dist
86 | 
87 | install: clean ## install the package to the active Python's site-packages
88 | 	python setup.py install
89 | 


--------------------------------------------------------------------------------
/README.rst:
--------------------------------------------------------------------------------
 1 | =========
 2 | kinet2pcb
 3 | =========
 4 | 
 5 | 
 6 | .. image:: https://img.shields.io/pypi/v/kinet2pcb.svg
 7 |         :target: https://pypi.python.org/pypi/kinet2pcb
 8 | 
 9 | 
10 | Convert KiCad netlist into a PCBNEW ``.kicad_pcb`` file.
11 | 
12 | 
13 | * Free software: MIT license
14 | * Documentation: https://devbisme.github.io/kinet2pcb .
15 | 
16 | 
17 | Features
18 | --------
19 | 
20 | * Converts a KiCad netlist file into a ``.kicad_pcb`` file that can be edited with PCBNEW.
21 | 
22 | Credits
23 | -------
24 | 
25 | This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
26 | 
27 | .. _Cookiecutter: https://github.com/audreyr/cookiecutter
28 | .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
29 | 


--------------------------------------------------------------------------------
/docs/Makefile:
--------------------------------------------------------------------------------
 1 | # Minimal makefile for Sphinx documentation
 2 | #
 3 | 
 4 | # You can set these variables from the command line.
 5 | SPHINXOPTS    =
 6 | SPHINXBUILD   = sphinx-build
 7 | SPHINXPROJ    = kinet2pcb
 8 | SOURCEDIR     = .
 9 | BUILDDIR      = _build
10 | 
11 | # Put it first so that "make" without argument is like "make help".
12 | help:
13 | 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14 | 
15 | .PHONY: help Makefile
16 | 
17 | # Catch-all target: route all unknown targets to Sphinx using the new
18 | # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
19 | %: Makefile
20 | 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
21 | 


--------------------------------------------------------------------------------
/docs/_build/singlehtml/_static/ajax-loader.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/devbisme/kinet2pcb/1ccad5d6df308126427aa7c3d0eafa693386e230/docs/_build/singlehtml/_static/ajax-loader.gif


--------------------------------------------------------------------------------
/docs/_build/singlehtml/_static/alabaster.css:
--------------------------------------------------------------------------------
  1 | @import url("basic.css");
  2 | 
  3 | /* -- page layout ----------------------------------------------------------- */
  4 | 
  5 | body {
  6 |     font-family: Georgia, serif;
  7 |     font-size: 17px;
  8 |     background-color: #fff;
  9 |     color: #000;
 10 |     margin: 0;
 11 |     padding: 0;
 12 | }
 13 | 
 14 | 
 15 | div.document {
 16 |     width: 940px;
 17 |     margin: 30px auto 0 auto;
 18 | }
 19 | 
 20 | div.documentwrapper {
 21 |     float: left;
 22 |     width: 100%;
 23 | }
 24 | 
 25 | div.bodywrapper {
 26 |     margin: 0 0 0 220px;
 27 | }
 28 | 
 29 | div.sphinxsidebar {
 30 |     width: 220px;
 31 |     font-size: 14px;
 32 |     line-height: 1.5;
 33 | }
 34 | 
 35 | hr {
 36 |     border: 1px solid #B1B4B6;
 37 | }
 38 | 
 39 | div.body {
 40 |     background-color: #fff;
 41 |     color: #3E4349;
 42 |     padding: 0 30px 0 30px;
 43 | }
 44 | 
 45 | div.body > .section {
 46 |     text-align: left;
 47 | }
 48 | 
 49 | div.footer {
 50 |     width: 940px;
 51 |     margin: 20px auto 30px auto;
 52 |     font-size: 14px;
 53 |     color: #888;
 54 |     text-align: right;
 55 | }
 56 | 
 57 | div.footer a {
 58 |     color: #888;
 59 | }
 60 | 
 61 | p.caption {
 62 |     font-family: inherit;
 63 |     font-size: inherit;
 64 | }
 65 | 
 66 | 
 67 | div.relations {
 68 |     display: none;
 69 | }
 70 | 
 71 | 
 72 | div.sphinxsidebar a {
 73 |     color: #444;
 74 |     text-decoration: none;
 75 |     border-bottom: 1px dotted #999;
 76 | }
 77 | 
 78 | div.sphinxsidebar a:hover {
 79 |     border-bottom: 1px solid #999;
 80 | }
 81 | 
 82 | div.sphinxsidebarwrapper {
 83 |     padding: 18px 10px;
 84 | }
 85 | 
 86 | div.sphinxsidebarwrapper p.logo {
 87 |     padding: 0;
 88 |     margin: -10px 0 0 0px;
 89 |     text-align: center;
 90 | }
 91 | 
 92 | div.sphinxsidebarwrapper h1.logo {
 93 |     margin-top: -10px;
 94 |     text-align: center;
 95 |     margin-bottom: 5px;
 96 |     text-align: left;
 97 | }
 98 | 
 99 | div.sphinxsidebarwrapper h1.logo-name {
100 |     margin-top: 0px;
101 | }
102 | 
103 | div.sphinxsidebarwrapper p.blurb {
104 |     margin-top: 0;
105 |     font-style: normal;
106 | }
107 | 
108 | div.sphinxsidebar h3,
109 | div.sphinxsidebar h4 {
110 |     font-family: Georgia, serif;
111 |     color: #444;
112 |     font-size: 24px;
113 |     font-weight: normal;
114 |     margin: 0 0 5px 0;
115 |     padding: 0;
116 | }
117 | 
118 | div.sphinxsidebar h4 {
119 |     font-size: 20px;
120 | }
121 | 
122 | div.sphinxsidebar h3 a {
123 |     color: #444;
124 | }
125 | 
126 | div.sphinxsidebar p.logo a,
127 | div.sphinxsidebar h3 a,
128 | div.sphinxsidebar p.logo a:hover,
129 | div.sphinxsidebar h3 a:hover {
130 |     border: none;
131 | }
132 | 
133 | div.sphinxsidebar p {
134 |     color: #555;
135 |     margin: 10px 0;
136 | }
137 | 
138 | div.sphinxsidebar ul {
139 |     margin: 10px 0;
140 |     padding: 0;
141 |     color: #000;
142 | }
143 | 
144 | div.sphinxsidebar ul li.toctree-l1 > a {
145 |     font-size: 120%;
146 | }
147 | 
148 | div.sphinxsidebar ul li.toctree-l2 > a {
149 |     font-size: 110%;
150 | }
151 | 
152 | div.sphinxsidebar input {
153 |     border: 1px solid #CCC;
154 |     font-family: Georgia, serif;
155 |     font-size: 1em;
156 | }
157 | 
158 | div.sphinxsidebar hr {
159 |     border: none;
160 |     height: 1px;
161 |     color: #AAA;
162 |     background: #AAA;
163 | 
164 |     text-align: left;
165 |     margin-left: 0;
166 |     width: 50%;
167 | }
168 | 
169 | div.sphinxsidebar .badge {
170 |     border-bottom: none;
171 | }
172 | 
173 | div.sphinxsidebar .badge:hover {
174 |     border-bottom: none;
175 | }
176 | 
177 | /* To address an issue with donation coming after search */
178 | div.sphinxsidebar h3.donation {
179 |     margin-top: 10px;
180 | }
181 | 
182 | /* -- body styles ----------------------------------------------------------- */
183 | 
184 | a {
185 |     color: #004B6B;
186 |     text-decoration: underline;
187 | }
188 | 
189 | a:hover {
190 |     color: #6D4100;
191 |     text-decoration: underline;
192 | }
193 | 
194 | div.body h1,
195 | div.body h2,
196 | div.body h3,
197 | div.body h4,
198 | div.body h5,
199 | div.body h6 {
200 |     font-family: Georgia, serif;
201 |     font-weight: normal;
202 |     margin: 30px 0px 10px 0px;
203 |     padding: 0;
204 | }
205 | 
206 | div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; }
207 | div.body h2 { font-size: 180%; }
208 | div.body h3 { font-size: 150%; }
209 | div.body h4 { font-size: 130%; }
210 | div.body h5 { font-size: 100%; }
211 | div.body h6 { font-size: 100%; }
212 | 
213 | a.headerlink {
214 |     color: #DDD;
215 |     padding: 0 4px;
216 |     text-decoration: none;
217 | }
218 | 
219 | a.headerlink:hover {
220 |     color: #444;
221 |     background: #EAEAEA;
222 | }
223 | 
224 | div.body p, div.body dd, div.body li {
225 |     line-height: 1.4em;
226 | }
227 | 
228 | div.admonition {
229 |     margin: 20px 0px;
230 |     padding: 10px 30px;
231 |     background-color: #EEE;
232 |     border: 1px solid #CCC;
233 | }
234 | 
235 | div.admonition tt.xref, div.admonition code.xref, div.admonition a tt {
236 |     background-color: #FBFBFB;
237 |     border-bottom: 1px solid #fafafa;
238 | }
239 | 
240 | div.admonition p.admonition-title {
241 |     font-family: Georgia, serif;
242 |     font-weight: normal;
243 |     font-size: 24px;
244 |     margin: 0 0 10px 0;
245 |     padding: 0;
246 |     line-height: 1;
247 | }
248 | 
249 | div.admonition p.last {
250 |     margin-bottom: 0;
251 | }
252 | 
253 | div.highlight {
254 |     background-color: #fff;
255 | }
256 | 
257 | dt:target, .highlight {
258 |     background: #FAF3E8;
259 | }
260 | 
261 | div.warning {
262 |     background-color: #FCC;
263 |     border: 1px solid #FAA;
264 | }
265 | 
266 | div.danger {
267 |     background-color: #FCC;
268 |     border: 1px solid #FAA;
269 |     -moz-box-shadow: 2px 2px 4px #D52C2C;
270 |     -webkit-box-shadow: 2px 2px 4px #D52C2C;
271 |     box-shadow: 2px 2px 4px #D52C2C;
272 | }
273 | 
274 | div.error {
275 |     background-color: #FCC;
276 |     border: 1px solid #FAA;
277 |     -moz-box-shadow: 2px 2px 4px #D52C2C;
278 |     -webkit-box-shadow: 2px 2px 4px #D52C2C;
279 |     box-shadow: 2px 2px 4px #D52C2C;
280 | }
281 | 
282 | div.caution {
283 |     background-color: #FCC;
284 |     border: 1px solid #FAA;
285 | }
286 | 
287 | div.attention {
288 |     background-color: #FCC;
289 |     border: 1px solid #FAA;
290 | }
291 | 
292 | div.important {
293 |     background-color: #EEE;
294 |     border: 1px solid #CCC;
295 | }
296 | 
297 | div.note {
298 |     background-color: #EEE;
299 |     border: 1px solid #CCC;
300 | }
301 | 
302 | div.tip {
303 |     background-color: #EEE;
304 |     border: 1px solid #CCC;
305 | }
306 | 
307 | div.hint {
308 |     background-color: #EEE;
309 |     border: 1px solid #CCC;
310 | }
311 | 
312 | div.seealso {
313 |     background-color: #EEE;
314 |     border: 1px solid #CCC;
315 | }
316 | 
317 | div.topic {
318 |     background-color: #EEE;
319 | }
320 | 
321 | p.admonition-title {
322 |     display: inline;
323 | }
324 | 
325 | p.admonition-title:after {
326 |     content: ":";
327 | }
328 | 
329 | pre, tt, code {
330 |     font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
331 |     font-size: 0.9em;
332 | }
333 | 
334 | .hll {
335 |     background-color: #FFC;
336 |     margin: 0 -12px;
337 |     padding: 0 12px;
338 |     display: block;
339 | }
340 | 
341 | img.screenshot {
342 | }
343 | 
344 | tt.descname, tt.descclassname, code.descname, code.descclassname {
345 |     font-size: 0.95em;
346 | }
347 | 
348 | tt.descname, code.descname {
349 |     padding-right: 0.08em;
350 | }
351 | 
352 | img.screenshot {
353 |     -moz-box-shadow: 2px 2px 4px #EEE;
354 |     -webkit-box-shadow: 2px 2px 4px #EEE;
355 |     box-shadow: 2px 2px 4px #EEE;
356 | }
357 | 
358 | table.docutils {
359 |     border: 1px solid #888;
360 |     -moz-box-shadow: 2px 2px 4px #EEE;
361 |     -webkit-box-shadow: 2px 2px 4px #EEE;
362 |     box-shadow: 2px 2px 4px #EEE;
363 | }
364 | 
365 | table.docutils td, table.docutils th {
366 |     border: 1px solid #888;
367 |     padding: 0.25em 0.7em;
368 | }
369 | 
370 | table.field-list, table.footnote {
371 |     border: none;
372 |     -moz-box-shadow: none;
373 |     -webkit-box-shadow: none;
374 |     box-shadow: none;
375 | }
376 | 
377 | table.footnote {
378 |     margin: 15px 0;
379 |     width: 100%;
380 |     border: 1px solid #EEE;
381 |     background: #FDFDFD;
382 |     font-size: 0.9em;
383 | }
384 | 
385 | table.footnote + table.footnote {
386 |     margin-top: -15px;
387 |     border-top: none;
388 | }
389 | 
390 | table.field-list th {
391 |     padding: 0 0.8em 0 0;
392 | }
393 | 
394 | table.field-list td {
395 |     padding: 0;
396 | }
397 | 
398 | table.field-list p {
399 |     margin-bottom: 0.8em;
400 | }
401 | 
402 | /* Cloned from
403 |  * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68
404 |  */
405 | .field-name {
406 |     -moz-hyphens: manual;
407 |     -ms-hyphens: manual;
408 |     -webkit-hyphens: manual;
409 |     hyphens: manual;
410 | }
411 | 
412 | table.footnote td.label {
413 |     width: .1px;
414 |     padding: 0.3em 0 0.3em 0.5em;
415 | }
416 | 
417 | table.footnote td {
418 |     padding: 0.3em 0.5em;
419 | }
420 | 
421 | dl {
422 |     margin-left: 0;
423 |     margin-right: 0;
424 |     margin-top: 0;
425 |     padding: 0;
426 | }
427 | 
428 | dl dd {
429 |     margin-left: 30px;
430 | }
431 | 
432 | blockquote {
433 |     margin: 0 0 0 30px;
434 |     padding: 0;
435 | }
436 | 
437 | ul, ol {
438 |     /* Matches the 30px from the narrow-screen "li > ul" selector below */
439 |     margin: 10px 0 10px 30px;
440 |     padding: 0;
441 | }
442 | 
443 | pre {
444 |     background: #EEE;
445 |     padding: 7px 30px;
446 |     margin: 15px 0px;
447 |     line-height: 1.3em;
448 | }
449 | 
450 | div.viewcode-block:target {
451 |     background: #ffd;
452 | }
453 | 
454 | dl pre, blockquote pre, li pre {
455 |     margin-left: 0;
456 |     padding-left: 30px;
457 | }
458 | 
459 | tt, code {
460 |     background-color: #ecf0f3;
461 |     color: #222;
462 |     /* padding: 1px 2px; */
463 | }
464 | 
465 | tt.xref, code.xref, a tt {
466 |     background-color: #FBFBFB;
467 |     border-bottom: 1px solid #fff;
468 | }
469 | 
470 | a.reference {
471 |     text-decoration: none;
472 |     border-bottom: 1px dotted #004B6B;
473 | }
474 | 
475 | /* Don't put an underline on images */
476 | a.image-reference, a.image-reference:hover {
477 |     border-bottom: none;
478 | }
479 | 
480 | a.reference:hover {
481 |     border-bottom: 1px solid #6D4100;
482 | }
483 | 
484 | a.footnote-reference {
485 |     text-decoration: none;
486 |     font-size: 0.7em;
487 |     vertical-align: top;
488 |     border-bottom: 1px dotted #004B6B;
489 | }
490 | 
491 | a.footnote-reference:hover {
492 |     border-bottom: 1px solid #6D4100;
493 | }
494 | 
495 | a:hover tt, a:hover code {
496 |     background: #EEE;
497 | }
498 | 
499 | 
500 | @media screen and (max-width: 870px) {
501 | 
502 |     div.sphinxsidebar {
503 |     	display: none;
504 |     }
505 | 
506 |     div.document {
507 |        width: 100%;
508 | 
509 |     }
510 | 
511 |     div.documentwrapper {
512 |     	margin-left: 0;
513 |     	margin-top: 0;
514 |     	margin-right: 0;
515 |     	margin-bottom: 0;
516 |     }
517 | 
518 |     div.bodywrapper {
519 |     	margin-top: 0;
520 |     	margin-right: 0;
521 |     	margin-bottom: 0;
522 |     	margin-left: 0;
523 |     }
524 | 
525 |     ul {
526 |     	margin-left: 0;
527 |     }
528 | 
529 | 	li > ul {
530 |         /* Matches the 30px from the "ul, ol" selector above */
531 | 		margin-left: 30px;
532 | 	}
533 | 
534 |     .document {
535 |     	width: auto;
536 |     }
537 | 
538 |     .footer {
539 |     	width: auto;
540 |     }
541 | 
542 |     .bodywrapper {
543 |     	margin: 0;
544 |     }
545 | 
546 |     .footer {
547 |     	width: auto;
548 |     }
549 | 
550 |     .github {
551 |         display: none;
552 |     }
553 | 
554 | 
555 | 
556 | }
557 | 
558 | 
559 | 
560 | @media screen and (max-width: 875px) {
561 | 
562 |     body {
563 |         margin: 0;
564 |         padding: 20px 30px;
565 |     }
566 | 
567 |     div.documentwrapper {
568 |         float: none;
569 |         background: #fff;
570 |     }
571 | 
572 |     div.sphinxsidebar {
573 |         display: block;
574 |         float: none;
575 |         width: 102.5%;
576 |         margin: 50px -30px -20px -30px;
577 |         padding: 10px 20px;
578 |         background: #333;
579 |         color: #FFF;
580 |     }
581 | 
582 |     div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p,
583 |     div.sphinxsidebar h3 a {
584 |         color: #fff;
585 |     }
586 | 
587 |     div.sphinxsidebar a {
588 |         color: #AAA;
589 |     }
590 | 
591 |     div.sphinxsidebar p.logo {
592 |         display: none;
593 |     }
594 | 
595 |     div.document {
596 |         width: 100%;
597 |         margin: 0;
598 |     }
599 | 
600 |     div.footer {
601 |         display: none;
602 |     }
603 | 
604 |     div.bodywrapper {
605 |         margin: 0;
606 |     }
607 | 
608 |     div.body {
609 |         min-height: 0;
610 |         padding: 0;
611 |     }
612 | 
613 |     .rtd_doc_footer {
614 |         display: none;
615 |     }
616 | 
617 |     .document {
618 |         width: auto;
619 |     }
620 | 
621 |     .footer {
622 |         width: auto;
623 |     }
624 | 
625 |     .footer {
626 |         width: auto;
627 |     }
628 | 
629 |     .github {
630 |         display: none;
631 |     }
632 | }
633 | 
634 | 
635 | /* misc. */
636 | 
637 | .revsys-inline {
638 |     display: none!important;
639 | }
640 | 
641 | /* Make nested-list/multi-paragraph items look better in Releases changelog
642 |  * pages. Without this, docutils' magical list fuckery causes inconsistent
643 |  * formatting between different release sub-lists.
644 |  */
645 | div#changelog > div.section > ul > li > p:only-child {
646 |     margin-bottom: 0;
647 | }
648 | 
649 | /* Hide fugly table cell borders in ..bibliography:: directive output */
650 | table.docutils.citation, table.docutils.citation td, table.docutils.citation th {
651 |   border: none;
652 |   /* Below needed in some edge cases; if not applied, bottom shadows appear */
653 |   -moz-box-shadow: none;
654 |   -webkit-box-shadow: none;
655 |   box-shadow: none;
656 | }
657 | 
658 | 
659 | /* relbar */
660 | 
661 | .related {
662 |     line-height: 30px;
663 |     width: 100%;
664 |     font-size: 0.9rem;
665 | }
666 | 
667 | .related.top {
668 |     border-bottom: 1px solid #EEE;
669 |     margin-bottom: 20px;
670 | }
671 | 
672 | .related.bottom {
673 |     border-top: 1px solid #EEE;
674 | }
675 | 
676 | .related ul {
677 |     padding: 0;
678 |     margin: 0;
679 |     list-style: none;
680 | }
681 | 
682 | .related li {
683 |     display: inline;
684 | }
685 | 
686 | nav#rellinks {
687 |     float: right;
688 | }
689 | 
690 | nav#rellinks li+li:before {
691 |     content: "|";
692 | }
693 | 
694 | nav#breadcrumbs li+li:before {
695 |     content: "\00BB";
696 | }
697 | 
698 | /* Hide certain items when printing */
699 | @media print {
700 |     div.related {
701 |         display: none;
702 |     }
703 | }


--------------------------------------------------------------------------------
/docs/_build/singlehtml/_static/basic.css:
--------------------------------------------------------------------------------
  1 | /*
  2 |  * basic.css
  3 |  * ~~~~~~~~~
  4 |  *
  5 |  * Sphinx stylesheet -- basic theme.
  6 |  *
  7 |  * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
  8 |  * :license: BSD, see LICENSE for details.
  9 |  *
 10 |  */
 11 | 
 12 | /* -- main layout ----------------------------------------------------------- */
 13 | 
 14 | div.clearer {
 15 |     clear: both;
 16 | }
 17 | 
 18 | div.section::after {
 19 |     display: block;
 20 |     content: '';
 21 |     clear: left;
 22 | }
 23 | 
 24 | /* -- relbar ---------------------------------------------------------------- */
 25 | 
 26 | div.related {
 27 |     width: 100%;
 28 |     font-size: 90%;
 29 | }
 30 | 
 31 | div.related h3 {
 32 |     display: none;
 33 | }
 34 | 
 35 | div.related ul {
 36 |     margin: 0;
 37 |     padding: 0 0 0 10px;
 38 |     list-style: none;
 39 | }
 40 | 
 41 | div.related li {
 42 |     display: inline;
 43 | }
 44 | 
 45 | div.related li.right {
 46 |     float: right;
 47 |     margin-right: 5px;
 48 | }
 49 | 
 50 | /* -- sidebar --------------------------------------------------------------- */
 51 | 
 52 | div.sphinxsidebarwrapper {
 53 |     padding: 10px 5px 0 10px;
 54 | }
 55 | 
 56 | div.sphinxsidebar {
 57 |     float: left;
 58 |     width: 230px;
 59 |     margin-left: -100%;
 60 |     font-size: 90%;
 61 |     word-wrap: break-word;
 62 |     overflow-wrap : break-word;
 63 | }
 64 | 
 65 | div.sphinxsidebar ul {
 66 |     list-style: none;
 67 | }
 68 | 
 69 | div.sphinxsidebar ul ul,
 70 | div.sphinxsidebar ul.want-points {
 71 |     margin-left: 20px;
 72 |     list-style: square;
 73 | }
 74 | 
 75 | div.sphinxsidebar ul ul {
 76 |     margin-top: 0;
 77 |     margin-bottom: 0;
 78 | }
 79 | 
 80 | div.sphinxsidebar form {
 81 |     margin-top: 10px;
 82 | }
 83 | 
 84 | div.sphinxsidebar input {
 85 |     border: 1px solid #98dbcc;
 86 |     font-family: sans-serif;
 87 |     font-size: 1em;
 88 | }
 89 | 
 90 | div.sphinxsidebar #searchbox form.search {
 91 |     overflow: hidden;
 92 | }
 93 | 
 94 | div.sphinxsidebar #searchbox input[type="text"] {
 95 |     float: left;
 96 |     width: 80%;
 97 |     padding: 0.25em;
 98 |     box-sizing: border-box;
 99 | }
100 | 
101 | div.sphinxsidebar #searchbox input[type="submit"] {
102 |     float: left;
103 |     width: 20%;
104 |     border-left: none;
105 |     padding: 0.25em;
106 |     box-sizing: border-box;
107 | }
108 | 
109 | 
110 | img {
111 |     border: 0;
112 |     max-width: 100%;
113 | }
114 | 
115 | /* -- search page ----------------------------------------------------------- */
116 | 
117 | ul.search {
118 |     margin: 10px 0 0 20px;
119 |     padding: 0;
120 | }
121 | 
122 | ul.search li {
123 |     padding: 5px 0 5px 20px;
124 |     background-image: url(file.png);
125 |     background-repeat: no-repeat;
126 |     background-position: 0 7px;
127 | }
128 | 
129 | ul.search li a {
130 |     font-weight: bold;
131 | }
132 | 
133 | ul.search li p.context {
134 |     color: #888;
135 |     margin: 2px 0 0 30px;
136 |     text-align: left;
137 | }
138 | 
139 | ul.keywordmatches li.goodmatch a {
140 |     font-weight: bold;
141 | }
142 | 
143 | /* -- index page ------------------------------------------------------------ */
144 | 
145 | table.contentstable {
146 |     width: 90%;
147 |     margin-left: auto;
148 |     margin-right: auto;
149 | }
150 | 
151 | table.contentstable p.biglink {
152 |     line-height: 150%;
153 | }
154 | 
155 | a.biglink {
156 |     font-size: 1.3em;
157 | }
158 | 
159 | span.linkdescr {
160 |     font-style: italic;
161 |     padding-top: 5px;
162 |     font-size: 90%;
163 | }
164 | 
165 | /* -- general index --------------------------------------------------------- */
166 | 
167 | table.indextable {
168 |     width: 100%;
169 | }
170 | 
171 | table.indextable td {
172 |     text-align: left;
173 |     vertical-align: top;
174 | }
175 | 
176 | table.indextable ul {
177 |     margin-top: 0;
178 |     margin-bottom: 0;
179 |     list-style-type: none;
180 | }
181 | 
182 | table.indextable > tbody > tr > td > ul {
183 |     padding-left: 0em;
184 | }
185 | 
186 | table.indextable tr.pcap {
187 |     height: 10px;
188 | }
189 | 
190 | table.indextable tr.cap {
191 |     margin-top: 10px;
192 |     background-color: #f2f2f2;
193 | }
194 | 
195 | img.toggler {
196 |     margin-right: 3px;
197 |     margin-top: 3px;
198 |     cursor: pointer;
199 | }
200 | 
201 | div.modindex-jumpbox {
202 |     border-top: 1px solid #ddd;
203 |     border-bottom: 1px solid #ddd;
204 |     margin: 1em 0 1em 0;
205 |     padding: 0.4em;
206 | }
207 | 
208 | div.genindex-jumpbox {
209 |     border-top: 1px solid #ddd;
210 |     border-bottom: 1px solid #ddd;
211 |     margin: 1em 0 1em 0;
212 |     padding: 0.4em;
213 | }
214 | 
215 | /* -- domain module index --------------------------------------------------- */
216 | 
217 | table.modindextable td {
218 |     padding: 2px;
219 |     border-collapse: collapse;
220 | }
221 | 
222 | /* -- general body styles --------------------------------------------------- */
223 | 
224 | div.body {
225 |     min-width: 360px;
226 |     max-width: 800px;
227 | }
228 | 
229 | div.body p, div.body dd, div.body li, div.body blockquote {
230 |     -moz-hyphens: auto;
231 |     -ms-hyphens: auto;
232 |     -webkit-hyphens: auto;
233 |     hyphens: auto;
234 | }
235 | 
236 | a.headerlink {
237 |     visibility: hidden;
238 | }
239 | 
240 | h1:hover > a.headerlink,
241 | h2:hover > a.headerlink,
242 | h3:hover > a.headerlink,
243 | h4:hover > a.headerlink,
244 | h5:hover > a.headerlink,
245 | h6:hover > a.headerlink,
246 | dt:hover > a.headerlink,
247 | caption:hover > a.headerlink,
248 | p.caption:hover > a.headerlink,
249 | div.code-block-caption:hover > a.headerlink {
250 |     visibility: visible;
251 | }
252 | 
253 | div.body p.caption {
254 |     text-align: inherit;
255 | }
256 | 
257 | div.body td {
258 |     text-align: left;
259 | }
260 | 
261 | .first {
262 |     margin-top: 0 !important;
263 | }
264 | 
265 | p.rubric {
266 |     margin-top: 30px;
267 |     font-weight: bold;
268 | }
269 | 
270 | img.align-left, figure.align-left, .figure.align-left, object.align-left {
271 |     clear: left;
272 |     float: left;
273 |     margin-right: 1em;
274 | }
275 | 
276 | img.align-right, figure.align-right, .figure.align-right, object.align-right {
277 |     clear: right;
278 |     float: right;
279 |     margin-left: 1em;
280 | }
281 | 
282 | img.align-center, figure.align-center, .figure.align-center, object.align-center {
283 |   display: block;
284 |   margin-left: auto;
285 |   margin-right: auto;
286 | }
287 | 
288 | img.align-default, figure.align-default, .figure.align-default {
289 |   display: block;
290 |   margin-left: auto;
291 |   margin-right: auto;
292 | }
293 | 
294 | .align-left {
295 |     text-align: left;
296 | }
297 | 
298 | .align-center {
299 |     text-align: center;
300 | }
301 | 
302 | .align-default {
303 |     text-align: center;
304 | }
305 | 
306 | .align-right {
307 |     text-align: right;
308 | }
309 | 
310 | /* -- sidebars -------------------------------------------------------------- */
311 | 
312 | div.sidebar,
313 | aside.sidebar {
314 |     margin: 0 0 0.5em 1em;
315 |     border: 1px solid #ddb;
316 |     padding: 7px;
317 |     background-color: #ffe;
318 |     width: 40%;
319 |     float: right;
320 |     clear: right;
321 |     overflow-x: auto;
322 | }
323 | 
324 | p.sidebar-title {
325 |     font-weight: bold;
326 | }
327 | nav.contents,
328 | aside.topic,
329 | 
330 | div.admonition, div.topic, blockquote {
331 |     clear: left;
332 | }
333 | 
334 | /* -- topics ---------------------------------------------------------------- */
335 | nav.contents,
336 | aside.topic,
337 | 
338 | div.topic {
339 |     border: 1px solid #ccc;
340 |     padding: 7px;
341 |     margin: 10px 0 10px 0;
342 | }
343 | 
344 | p.topic-title {
345 |     font-size: 1.1em;
346 |     font-weight: bold;
347 |     margin-top: 10px;
348 | }
349 | 
350 | /* -- admonitions ----------------------------------------------------------- */
351 | 
352 | div.admonition {
353 |     margin-top: 10px;
354 |     margin-bottom: 10px;
355 |     padding: 7px;
356 | }
357 | 
358 | div.admonition dt {
359 |     font-weight: bold;
360 | }
361 | 
362 | p.admonition-title {
363 |     margin: 0px 10px 5px 0px;
364 |     font-weight: bold;
365 | }
366 | 
367 | div.body p.centered {
368 |     text-align: center;
369 |     margin-top: 25px;
370 | }
371 | 
372 | /* -- content of sidebars/topics/admonitions -------------------------------- */
373 | 
374 | div.sidebar > :last-child,
375 | aside.sidebar > :last-child,
376 | nav.contents > :last-child,
377 | aside.topic > :last-child,
378 | 
379 | div.topic > :last-child,
380 | div.admonition > :last-child {
381 |     margin-bottom: 0;
382 | }
383 | 
384 | div.sidebar::after,
385 | aside.sidebar::after,
386 | nav.contents::after,
387 | aside.topic::after,
388 | 
389 | div.topic::after,
390 | div.admonition::after,
391 | blockquote::after {
392 |     display: block;
393 |     content: '';
394 |     clear: both;
395 | }
396 | 
397 | /* -- tables ---------------------------------------------------------------- */
398 | 
399 | table.docutils {
400 |     margin-top: 10px;
401 |     margin-bottom: 10px;
402 |     border: 0;
403 |     border-collapse: collapse;
404 | }
405 | 
406 | table.align-center {
407 |     margin-left: auto;
408 |     margin-right: auto;
409 | }
410 | 
411 | table.align-default {
412 |     margin-left: auto;
413 |     margin-right: auto;
414 | }
415 | 
416 | table caption span.caption-number {
417 |     font-style: italic;
418 | }
419 | 
420 | table caption span.caption-text {
421 | }
422 | 
423 | table.docutils td, table.docutils th {
424 |     padding: 1px 8px 1px 5px;
425 |     border-top: 0;
426 |     border-left: 0;
427 |     border-right: 0;
428 |     border-bottom: 1px solid #aaa;
429 | }
430 | 
431 | th {
432 |     text-align: left;
433 |     padding-right: 5px;
434 | }
435 | 
436 | table.citation {
437 |     border-left: solid 1px gray;
438 |     margin-left: 1px;
439 | }
440 | 
441 | table.citation td {
442 |     border-bottom: none;
443 | }
444 | 
445 | th > :first-child,
446 | td > :first-child {
447 |     margin-top: 0px;
448 | }
449 | 
450 | th > :last-child,
451 | td > :last-child {
452 |     margin-bottom: 0px;
453 | }
454 | 
455 | /* -- figures --------------------------------------------------------------- */
456 | 
457 | div.figure, figure {
458 |     margin: 0.5em;
459 |     padding: 0.5em;
460 | }
461 | 
462 | div.figure p.caption, figcaption {
463 |     padding: 0.3em;
464 | }
465 | 
466 | div.figure p.caption span.caption-number,
467 | figcaption span.caption-number {
468 |     font-style: italic;
469 | }
470 | 
471 | div.figure p.caption span.caption-text,
472 | figcaption span.caption-text {
473 | }
474 | 
475 | /* -- field list styles ----------------------------------------------------- */
476 | 
477 | table.field-list td, table.field-list th {
478 |     border: 0 !important;
479 | }
480 | 
481 | .field-list ul {
482 |     margin: 0;
483 |     padding-left: 1em;
484 | }
485 | 
486 | .field-list p {
487 |     margin: 0;
488 | }
489 | 
490 | .field-name {
491 |     -moz-hyphens: manual;
492 |     -ms-hyphens: manual;
493 |     -webkit-hyphens: manual;
494 |     hyphens: manual;
495 | }
496 | 
497 | /* -- hlist styles ---------------------------------------------------------- */
498 | 
499 | table.hlist {
500 |     margin: 1em 0;
501 | }
502 | 
503 | table.hlist td {
504 |     vertical-align: top;
505 | }
506 | 
507 | /* -- object description styles --------------------------------------------- */
508 | 
509 | .sig {
510 | 	font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
511 | }
512 | 
513 | .sig-name, code.descname {
514 |     background-color: transparent;
515 |     font-weight: bold;
516 | }
517 | 
518 | .sig-name {
519 | 	font-size: 1.1em;
520 | }
521 | 
522 | code.descname {
523 |     font-size: 1.2em;
524 | }
525 | 
526 | .sig-prename, code.descclassname {
527 |     background-color: transparent;
528 | }
529 | 
530 | .optional {
531 |     font-size: 1.3em;
532 | }
533 | 
534 | .sig-paren {
535 |     font-size: larger;
536 | }
537 | 
538 | .sig-param.n {
539 | 	font-style: italic;
540 | }
541 | 
542 | /* C++ specific styling */
543 | 
544 | .sig-inline.c-texpr,
545 | .sig-inline.cpp-texpr {
546 | 	font-family: unset;
547 | }
548 | 
549 | .sig.c   .k, .sig.c   .kt,
550 | .sig.cpp .k, .sig.cpp .kt {
551 | 	color: #0033B3;
552 | }
553 | 
554 | .sig.c   .m,
555 | .sig.cpp .m {
556 | 	color: #1750EB;
557 | }
558 | 
559 | .sig.c   .s, .sig.c   .sc,
560 | .sig.cpp .s, .sig.cpp .sc {
561 | 	color: #067D17;
562 | }
563 | 
564 | 
565 | /* -- other body styles ----------------------------------------------------- */
566 | 
567 | ol.arabic {
568 |     list-style: decimal;
569 | }
570 | 
571 | ol.loweralpha {
572 |     list-style: lower-alpha;
573 | }
574 | 
575 | ol.upperalpha {
576 |     list-style: upper-alpha;
577 | }
578 | 
579 | ol.lowerroman {
580 |     list-style: lower-roman;
581 | }
582 | 
583 | ol.upperroman {
584 |     list-style: upper-roman;
585 | }
586 | 
587 | :not(li) > ol > li:first-child > :first-child,
588 | :not(li) > ul > li:first-child > :first-child {
589 |     margin-top: 0px;
590 | }
591 | 
592 | :not(li) > ol > li:last-child > :last-child,
593 | :not(li) > ul > li:last-child > :last-child {
594 |     margin-bottom: 0px;
595 | }
596 | 
597 | ol.simple ol p,
598 | ol.simple ul p,
599 | ul.simple ol p,
600 | ul.simple ul p {
601 |     margin-top: 0;
602 | }
603 | 
604 | ol.simple > li:not(:first-child) > p,
605 | ul.simple > li:not(:first-child) > p {
606 |     margin-top: 0;
607 | }
608 | 
609 | ol.simple p,
610 | ul.simple p {
611 |     margin-bottom: 0;
612 | }
613 | 
614 | /* Docutils 0.17 and older (footnotes & citations) */
615 | dl.footnote > dt,
616 | dl.citation > dt {
617 |     float: left;
618 |     margin-right: 0.5em;
619 | }
620 | 
621 | dl.footnote > dd,
622 | dl.citation > dd {
623 |     margin-bottom: 0em;
624 | }
625 | 
626 | dl.footnote > dd:after,
627 | dl.citation > dd:after {
628 |     content: "";
629 |     clear: both;
630 | }
631 | 
632 | /* Docutils 0.18+ (footnotes & citations) */
633 | aside.footnote > span,
634 | div.citation > span {
635 |     float: left;
636 | }
637 | aside.footnote > span:last-of-type,
638 | div.citation > span:last-of-type {
639 |   padding-right: 0.5em;
640 | }
641 | aside.footnote > p {
642 |   margin-left: 2em;
643 | }
644 | div.citation > p {
645 |   margin-left: 4em;
646 | }
647 | aside.footnote > p:last-of-type,
648 | div.citation > p:last-of-type {
649 |     margin-bottom: 0em;
650 | }
651 | aside.footnote > p:last-of-type:after,
652 | div.citation > p:last-of-type:after {
653 |     content: "";
654 |     clear: both;
655 | }
656 | 
657 | /* Footnotes & citations ends */
658 | 
659 | dl.field-list {
660 |     display: grid;
661 |     grid-template-columns: fit-content(30%) auto;
662 | }
663 | 
664 | dl.field-list > dt {
665 |     font-weight: bold;
666 |     word-break: break-word;
667 |     padding-left: 0.5em;
668 |     padding-right: 5px;
669 | }
670 | 
671 | dl.field-list > dt:after {
672 |     content: ":";
673 | }
674 | 
675 | dl.field-list > dd {
676 |     padding-left: 0.5em;
677 |     margin-top: 0em;
678 |     margin-left: 0em;
679 |     margin-bottom: 0em;
680 | }
681 | 
682 | dl {
683 |     margin-bottom: 15px;
684 | }
685 | 
686 | dd > :first-child {
687 |     margin-top: 0px;
688 | }
689 | 
690 | dd ul, dd table {
691 |     margin-bottom: 10px;
692 | }
693 | 
694 | dd {
695 |     margin-top: 3px;
696 |     margin-bottom: 10px;
697 |     margin-left: 30px;
698 | }
699 | 
700 | dl > dd:last-child,
701 | dl > dd:last-child > :last-child {
702 |     margin-bottom: 0;
703 | }
704 | 
705 | dt:target, span.highlighted {
706 |     background-color: #fbe54e;
707 | }
708 | 
709 | rect.highlighted {
710 |     fill: #fbe54e;
711 | }
712 | 
713 | dl.glossary dt {
714 |     font-weight: bold;
715 |     font-size: 1.1em;
716 | }
717 | 
718 | .versionmodified {
719 |     font-style: italic;
720 | }
721 | 
722 | .system-message {
723 |     background-color: #fda;
724 |     padding: 5px;
725 |     border: 3px solid red;
726 | }
727 | 
728 | .footnote:target  {
729 |     background-color: #ffa;
730 | }
731 | 
732 | .line-block {
733 |     display: block;
734 |     margin-top: 1em;
735 |     margin-bottom: 1em;
736 | }
737 | 
738 | .line-block .line-block {
739 |     margin-top: 0;
740 |     margin-bottom: 0;
741 |     margin-left: 1.5em;
742 | }
743 | 
744 | .guilabel, .menuselection {
745 |     font-family: sans-serif;
746 | }
747 | 
748 | .accelerator {
749 |     text-decoration: underline;
750 | }
751 | 
752 | .classifier {
753 |     font-style: oblique;
754 | }
755 | 
756 | .classifier:before {
757 |     font-style: normal;
758 |     margin: 0 0.5em;
759 |     content: ":";
760 |     display: inline-block;
761 | }
762 | 
763 | abbr, acronym {
764 |     border-bottom: dotted 1px;
765 |     cursor: help;
766 | }
767 | 
768 | /* -- code displays --------------------------------------------------------- */
769 | 
770 | pre {
771 |     overflow: auto;
772 |     overflow-y: hidden;  /* fixes display issues on Chrome browsers */
773 | }
774 | 
775 | pre, div[class*="highlight-"] {
776 |     clear: both;
777 | }
778 | 
779 | span.pre {
780 |     -moz-hyphens: none;
781 |     -ms-hyphens: none;
782 |     -webkit-hyphens: none;
783 |     hyphens: none;
784 |     white-space: nowrap;
785 | }
786 | 
787 | div[class*="highlight-"] {
788 |     margin: 1em 0;
789 | }
790 | 
791 | td.linenos pre {
792 |     border: 0;
793 |     background-color: transparent;
794 |     color: #aaa;
795 | }
796 | 
797 | table.highlighttable {
798 |     display: block;
799 | }
800 | 
801 | table.highlighttable tbody {
802 |     display: block;
803 | }
804 | 
805 | table.highlighttable tr {
806 |     display: flex;
807 | }
808 | 
809 | table.highlighttable td {
810 |     margin: 0;
811 |     padding: 0;
812 | }
813 | 
814 | table.highlighttable td.linenos {
815 |     padding-right: 0.5em;
816 | }
817 | 
818 | table.highlighttable td.code {
819 |     flex: 1;
820 |     overflow: hidden;
821 | }
822 | 
823 | .highlight .hll {
824 |     display: block;
825 | }
826 | 
827 | div.highlight pre,
828 | table.highlighttable pre {
829 |     margin: 0;
830 | }
831 | 
832 | div.code-block-caption + div {
833 |     margin-top: 0;
834 | }
835 | 
836 | div.code-block-caption {
837 |     margin-top: 1em;
838 |     padding: 2px 5px;
839 |     font-size: small;
840 | }
841 | 
842 | div.code-block-caption code {
843 |     background-color: transparent;
844 | }
845 | 
846 | table.highlighttable td.linenos,
847 | span.linenos,
848 | div.highlight span.gp {  /* gp: Generic.Prompt */
849 |   user-select: none;
850 |   -webkit-user-select: text; /* Safari fallback only */
851 |   -webkit-user-select: none; /* Chrome/Safari */
852 |   -moz-user-select: none; /* Firefox */
853 |   -ms-user-select: none; /* IE10+ */
854 | }
855 | 
856 | div.code-block-caption span.caption-number {
857 |     padding: 0.1em 0.3em;
858 |     font-style: italic;
859 | }
860 | 
861 | div.code-block-caption span.caption-text {
862 | }
863 | 
864 | div.literal-block-wrapper {
865 |     margin: 1em 0;
866 | }
867 | 
868 | code.xref, a code {
869 |     background-color: transparent;
870 |     font-weight: bold;
871 | }
872 | 
873 | h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
874 |     background-color: transparent;
875 | }
876 | 
877 | .viewcode-link {
878 |     float: right;
879 | }
880 | 
881 | .viewcode-back {
882 |     float: right;
883 |     font-family: sans-serif;
884 | }
885 | 
886 | div.viewcode-block:target {
887 |     margin: -1px -10px;
888 |     padding: 0 10px;
889 | }
890 | 
891 | /* -- math display ---------------------------------------------------------- */
892 | 
893 | img.math {
894 |     vertical-align: middle;
895 | }
896 | 
897 | div.body div.math p {
898 |     text-align: center;
899 | }
900 | 
901 | span.eqno {
902 |     float: right;
903 | }
904 | 
905 | span.eqno a.headerlink {
906 |     position: absolute;
907 |     z-index: 1;
908 | }
909 | 
910 | div.math:hover a.headerlink {
911 |     visibility: visible;
912 | }
913 | 
914 | /* -- printout stylesheet --------------------------------------------------- */
915 | 
916 | @media print {
917 |     div.document,
918 |     div.documentwrapper,
919 |     div.bodywrapper {
920 |         margin: 0 !important;
921 |         width: 100%;
922 |     }
923 | 
924 |     div.sphinxsidebar,
925 |     div.related,
926 |     div.footer,
927 |     #top-link {
928 |         display: none;
929 |     }
930 | }


--------------------------------------------------------------------------------
/docs/_build/singlehtml/_static/comment-bright.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/devbisme/kinet2pcb/1ccad5d6df308126427aa7c3d0eafa693386e230/docs/_build/singlehtml/_static/comment-bright.png


--------------------------------------------------------------------------------
/docs/_build/singlehtml/_static/comment-close.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/devbisme/kinet2pcb/1ccad5d6df308126427aa7c3d0eafa693386e230/docs/_build/singlehtml/_static/comment-close.png


--------------------------------------------------------------------------------
/docs/_build/singlehtml/_static/comment.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/devbisme/kinet2pcb/1ccad5d6df308126427aa7c3d0eafa693386e230/docs/_build/singlehtml/_static/comment.png


--------------------------------------------------------------------------------
/docs/_build/singlehtml/_static/custom.css:
--------------------------------------------------------------------------------
1 | /* This file intentionally left blank. */
2 | 


--------------------------------------------------------------------------------
/docs/_build/singlehtml/_static/doctools.js:
--------------------------------------------------------------------------------
  1 | /*
  2 |  * doctools.js
  3 |  * ~~~~~~~~~~~
  4 |  *
  5 |  * Base JavaScript utilities for all Sphinx HTML documentation.
  6 |  *
  7 |  * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
  8 |  * :license: BSD, see LICENSE for details.
  9 |  *
 10 |  */
 11 | "use strict";
 12 | 
 13 | const _ready = (callback) => {
 14 |   if (document.readyState !== "loading") {
 15 |     callback();
 16 |   } else {
 17 |     document.addEventListener("DOMContentLoaded", callback);
 18 |   }
 19 | };
 20 | 
 21 | /**
 22 |  * highlight a given string on a node by wrapping it in
 23 |  * span elements with the given class name.
 24 |  */
 25 | const _highlight = (node, addItems, text, className) => {
 26 |   if (node.nodeType === Node.TEXT_NODE) {
 27 |     const val = node.nodeValue;
 28 |     const parent = node.parentNode;
 29 |     const pos = val.toLowerCase().indexOf(text);
 30 |     if (
 31 |       pos >= 0 &&
 32 |       !parent.classList.contains(className) &&
 33 |       !parent.classList.contains("nohighlight")
 34 |     ) {
 35 |       let span;
 36 | 
 37 |       const closestNode = parent.closest("body, svg, foreignObject");
 38 |       const isInSVG = closestNode && closestNode.matches("svg");
 39 |       if (isInSVG) {
 40 |         span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
 41 |       } else {
 42 |         span = document.createElement("span");
 43 |         span.classList.add(className);
 44 |       }
 45 | 
 46 |       span.appendChild(document.createTextNode(val.substr(pos, text.length)));
 47 |       parent.insertBefore(
 48 |         span,
 49 |         parent.insertBefore(
 50 |           document.createTextNode(val.substr(pos + text.length)),
 51 |           node.nextSibling
 52 |         )
 53 |       );
 54 |       node.nodeValue = val.substr(0, pos);
 55 | 
 56 |       if (isInSVG) {
 57 |         const rect = document.createElementNS(
 58 |           "http://www.w3.org/2000/svg",
 59 |           "rect"
 60 |         );
 61 |         const bbox = parent.getBBox();
 62 |         rect.x.baseVal.value = bbox.x;
 63 |         rect.y.baseVal.value = bbox.y;
 64 |         rect.width.baseVal.value = bbox.width;
 65 |         rect.height.baseVal.value = bbox.height;
 66 |         rect.setAttribute("class", className);
 67 |         addItems.push({ parent: parent, target: rect });
 68 |       }
 69 |     }
 70 |   } else if (node.matches && !node.matches("button, select, textarea")) {
 71 |     node.childNodes.forEach((el) => _highlight(el, addItems, text, className));
 72 |   }
 73 | };
 74 | const _highlightText = (thisNode, text, className) => {
 75 |   let addItems = [];
 76 |   _highlight(thisNode, addItems, text, className);
 77 |   addItems.forEach((obj) =>
 78 |     obj.parent.insertAdjacentElement("beforebegin", obj.target)
 79 |   );
 80 | };
 81 | 
 82 | /**
 83 |  * Small JavaScript module for the documentation.
 84 |  */
 85 | const Documentation = {
 86 |   init: () => {
 87 |     Documentation.highlightSearchWords();
 88 |     Documentation.initDomainIndexTable();
 89 |     Documentation.initOnKeyListeners();
 90 |   },
 91 | 
 92 |   /**
 93 |    * i18n support
 94 |    */
 95 |   TRANSLATIONS: {},
 96 |   PLURAL_EXPR: (n) => (n === 1 ? 0 : 1),
 97 |   LOCALE: "unknown",
 98 | 
 99 |   // gettext and ngettext don't access this so that the functions
100 |   // can safely bound to a different name (_ = Documentation.gettext)
101 |   gettext: (string) => {
102 |     const translated = Documentation.TRANSLATIONS[string];
103 |     switch (typeof translated) {
104 |       case "undefined":
105 |         return string; // no translation
106 |       case "string":
107 |         return translated; // translation exists
108 |       default:
109 |         return translated[0]; // (singular, plural) translation tuple exists
110 |     }
111 |   },
112 | 
113 |   ngettext: (singular, plural, n) => {
114 |     const translated = Documentation.TRANSLATIONS[singular];
115 |     if (typeof translated !== "undefined")
116 |       return translated[Documentation.PLURAL_EXPR(n)];
117 |     return n === 1 ? singular : plural;
118 |   },
119 | 
120 |   addTranslations: (catalog) => {
121 |     Object.assign(Documentation.TRANSLATIONS, catalog.messages);
122 |     Documentation.PLURAL_EXPR = new Function(
123 |       "n",
124 |       `return (${catalog.plural_expr})`
125 |     );
126 |     Documentation.LOCALE = catalog.locale;
127 |   },
128 | 
129 |   /**
130 |    * highlight the search words provided in the url in the text
131 |    */
132 |   highlightSearchWords: () => {
133 |     const highlight =
134 |       new URLSearchParams(window.location.search).get("highlight") || "";
135 |     const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);
136 |     if (terms.length === 0) return; // nothing to do
137 | 
138 |     // There should never be more than one element matching "div.body"
139 |     const divBody = document.querySelectorAll("div.body");
140 |     const body = divBody.length ? divBody[0] : document.querySelector("body");
141 |     window.setTimeout(() => {
142 |       terms.forEach((term) => _highlightText(body, term, "highlighted"));
143 |     }, 10);
144 | 
145 |     const searchBox = document.getElementById("searchbox");
146 |     if (searchBox === null) return;
147 |     searchBox.appendChild(
148 |       document
149 |         .createRange()
150 |         .createContextualFragment(
151 |           '<p class="highlight-link">' +
152 |             '<a href="javascript:Documentation.hideSearchWords()">' +
153 |             Documentation.gettext("Hide Search Matches") +
154 |             "</a></p>"
155 |         )
156 |     );
157 |   },
158 | 
159 |   /**
160 |    * helper function to hide the search marks again
161 |    */
162 |   hideSearchWords: () => {
163 |     document
164 |       .querySelectorAll("#searchbox .highlight-link")
165 |       .forEach((el) => el.remove());
166 |     document
167 |       .querySelectorAll("span.highlighted")
168 |       .forEach((el) => el.classList.remove("highlighted"));
169 |     const url = new URL(window.location);
170 |     url.searchParams.delete("highlight");
171 |     window.history.replaceState({}, "", url);
172 |   },
173 | 
174 |   /**
175 |    * helper function to focus on search bar
176 |    */
177 |   focusSearchBar: () => {
178 |     document.querySelectorAll("input[name=q]")[0]?.focus();
179 |   },
180 | 
181 |   /**
182 |    * Initialise the domain index toggle buttons
183 |    */
184 |   initDomainIndexTable: () => {
185 |     const toggler = (el) => {
186 |       const idNumber = el.id.substr(7);
187 |       const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`);
188 |       if (el.src.substr(-9) === "minus.png") {
189 |         el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`;
190 |         toggledRows.forEach((el) => (el.style.display = "none"));
191 |       } else {
192 |         el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`;
193 |         toggledRows.forEach((el) => (el.style.display = ""));
194 |       }
195 |     };
196 | 
197 |     const togglerElements = document.querySelectorAll("img.toggler");
198 |     togglerElements.forEach((el) =>
199 |       el.addEventListener("click", (event) => toggler(event.currentTarget))
200 |     );
201 |     togglerElements.forEach((el) => (el.style.display = ""));
202 |     if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler);
203 |   },
204 | 
205 |   initOnKeyListeners: () => {
206 |     // only install a listener if it is really needed
207 |     if (
208 |       !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
209 |       !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS
210 |     )
211 |       return;
212 | 
213 |     const blacklistedElements = new Set([
214 |       "TEXTAREA",
215 |       "INPUT",
216 |       "SELECT",
217 |       "BUTTON",
218 |     ]);
219 |     document.addEventListener("keydown", (event) => {
220 |       if (blacklistedElements.has(document.activeElement.tagName)) return; // bail for input elements
221 |       if (event.altKey || event.ctrlKey || event.metaKey) return; // bail with special keys
222 | 
223 |       if (!event.shiftKey) {
224 |         switch (event.key) {
225 |           case "ArrowLeft":
226 |             if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
227 | 
228 |             const prevLink = document.querySelector('link[rel="prev"]');
229 |             if (prevLink && prevLink.href) {
230 |               window.location.href = prevLink.href;
231 |               event.preventDefault();
232 |             }
233 |             break;
234 |           case "ArrowRight":
235 |             if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
236 | 
237 |             const nextLink = document.querySelector('link[rel="next"]');
238 |             if (nextLink && nextLink.href) {
239 |               window.location.href = nextLink.href;
240 |               event.preventDefault();
241 |             }
242 |             break;
243 |           case "Escape":
244 |             if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;
245 |             Documentation.hideSearchWords();
246 |             event.preventDefault();
247 |         }
248 |       }
249 | 
250 |       // some keyboard layouts may need Shift to get /
251 |       switch (event.key) {
252 |         case "/":
253 |           if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;
254 |           Documentation.focusSearchBar();
255 |           event.preventDefault();
256 |       }
257 |     });
258 |   },
259 | };
260 | 
261 | // quick alias for translations
262 | const _ = Documentation.gettext;
263 | 
264 | _ready(Documentation.init);
265 | 


--------------------------------------------------------------------------------
/docs/_build/singlehtml/_static/documentation_options.js:
--------------------------------------------------------------------------------
 1 | var DOCUMENTATION_OPTIONS = {
 2 |     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
 3 |     VERSION: '1.1.2',
 4 |     LANGUAGE: 'en',
 5 |     COLLAPSE_INDEX: false,
 6 |     BUILDER: 'singlehtml',
 7 |     FILE_SUFFIX: '.html',
 8 |     LINK_SUFFIX: '.html',
 9 |     HAS_SOURCE: true,
10 |     SOURCELINK_SUFFIX: '.txt',
11 |     NAVIGATION_WITH_KEYS: false,
12 |     SHOW_SEARCH_SUMMARY: true,
13 |     ENABLE_SEARCH_SHORTCUTS: false,
14 | };


--------------------------------------------------------------------------------
/docs/_build/singlehtml/_static/down-pressed.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/devbisme/kinet2pcb/1ccad5d6df308126427aa7c3d0eafa693386e230/docs/_build/singlehtml/_static/down-pressed.png


--------------------------------------------------------------------------------
/docs/_build/singlehtml/_static/down.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/devbisme/kinet2pcb/1ccad5d6df308126427aa7c3d0eafa693386e230/docs/_build/singlehtml/_static/down.png


--------------------------------------------------------------------------------
/docs/_build/singlehtml/_static/file.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/devbisme/kinet2pcb/1ccad5d6df308126427aa7c3d0eafa693386e230/docs/_build/singlehtml/_static/file.png


--------------------------------------------------------------------------------
/docs/_build/singlehtml/_static/language_data.js:
--------------------------------------------------------------------------------
  1 | /*
  2 |  * language_data.js
  3 |  * ~~~~~~~~~~~~~~~~
  4 |  *
  5 |  * This script contains the language-specific data used by searchtools.js,
  6 |  * namely the list of stopwords, stemmer, scorer and splitter.
  7 |  *
  8 |  * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
  9 |  * :license: BSD, see LICENSE for details.
 10 |  *
 11 |  */
 12 | 
 13 | var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
 14 | 
 15 | 
 16 | /* Non-minified version is copied as a separate JS file, is available */
 17 | 
 18 | /**
 19 |  * Porter Stemmer
 20 |  */
 21 | var Stemmer = function() {
 22 | 
 23 |   var step2list = {
 24 |     ational: 'ate',
 25 |     tional: 'tion',
 26 |     enci: 'ence',
 27 |     anci: 'ance',
 28 |     izer: 'ize',
 29 |     bli: 'ble',
 30 |     alli: 'al',
 31 |     entli: 'ent',
 32 |     eli: 'e',
 33 |     ousli: 'ous',
 34 |     ization: 'ize',
 35 |     ation: 'ate',
 36 |     ator: 'ate',
 37 |     alism: 'al',
 38 |     iveness: 'ive',
 39 |     fulness: 'ful',
 40 |     ousness: 'ous',
 41 |     aliti: 'al',
 42 |     iviti: 'ive',
 43 |     biliti: 'ble',
 44 |     logi: 'log'
 45 |   };
 46 | 
 47 |   var step3list = {
 48 |     icate: 'ic',
 49 |     ative: '',
 50 |     alize: 'al',
 51 |     iciti: 'ic',
 52 |     ical: 'ic',
 53 |     ful: '',
 54 |     ness: ''
 55 |   };
 56 | 
 57 |   var c = "[^aeiou]";          // consonant
 58 |   var v = "[aeiouy]";          // vowel
 59 |   var C = c + "[^aeiouy]*";    // consonant sequence
 60 |   var V = v + "[aeiou]*";      // vowel sequence
 61 | 
 62 |   var mgr0 = "^(" + C + ")?" + V + C;                      // [C]VC... is m>0
 63 |   var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$";    // [C]VC[V] is m=1
 64 |   var mgr1 = "^(" + C + ")?" + V + C + V + C;              // [C]VCVC... is m>1
 65 |   var s_v   = "^(" + C + ")?" + v;                         // vowel in stem
 66 | 
 67 |   this.stemWord = function (w) {
 68 |     var stem;
 69 |     var suffix;
 70 |     var firstch;
 71 |     var origword = w;
 72 | 
 73 |     if (w.length < 3)
 74 |       return w;
 75 | 
 76 |     var re;
 77 |     var re2;
 78 |     var re3;
 79 |     var re4;
 80 | 
 81 |     firstch = w.substr(0,1);
 82 |     if (firstch == "y")
 83 |       w = firstch.toUpperCase() + w.substr(1);
 84 | 
 85 |     // Step 1a
 86 |     re = /^(.+?)(ss|i)es$/;
 87 |     re2 = /^(.+?)([^s])s$/;
 88 | 
 89 |     if (re.test(w))
 90 |       w = w.replace(re,"$1$2");
 91 |     else if (re2.test(w))
 92 |       w = w.replace(re2,"$1$2");
 93 | 
 94 |     // Step 1b
 95 |     re = /^(.+?)eed$/;
 96 |     re2 = /^(.+?)(ed|ing)$/;
 97 |     if (re.test(w)) {
 98 |       var fp = re.exec(w);
 99 |       re = new RegExp(mgr0);
100 |       if (re.test(fp[1])) {
101 |         re = /.$/;
102 |         w = w.replace(re,"");
103 |       }
104 |     }
105 |     else if (re2.test(w)) {
106 |       var fp = re2.exec(w);
107 |       stem = fp[1];
108 |       re2 = new RegExp(s_v);
109 |       if (re2.test(stem)) {
110 |         w = stem;
111 |         re2 = /(at|bl|iz)$/;
112 |         re3 = new RegExp("([^aeiouylsz])\\1$");
113 |         re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
114 |         if (re2.test(w))
115 |           w = w + "e";
116 |         else if (re3.test(w)) {
117 |           re = /.$/;
118 |           w = w.replace(re,"");
119 |         }
120 |         else if (re4.test(w))
121 |           w = w + "e";
122 |       }
123 |     }
124 | 
125 |     // Step 1c
126 |     re = /^(.+?)y$/;
127 |     if (re.test(w)) {
128 |       var fp = re.exec(w);
129 |       stem = fp[1];
130 |       re = new RegExp(s_v);
131 |       if (re.test(stem))
132 |         w = stem + "i";
133 |     }
134 | 
135 |     // Step 2
136 |     re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
137 |     if (re.test(w)) {
138 |       var fp = re.exec(w);
139 |       stem = fp[1];
140 |       suffix = fp[2];
141 |       re = new RegExp(mgr0);
142 |       if (re.test(stem))
143 |         w = stem + step2list[suffix];
144 |     }
145 | 
146 |     // Step 3
147 |     re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
148 |     if (re.test(w)) {
149 |       var fp = re.exec(w);
150 |       stem = fp[1];
151 |       suffix = fp[2];
152 |       re = new RegExp(mgr0);
153 |       if (re.test(stem))
154 |         w = stem + step3list[suffix];
155 |     }
156 | 
157 |     // Step 4
158 |     re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
159 |     re2 = /^(.+?)(s|t)(ion)$/;
160 |     if (re.test(w)) {
161 |       var fp = re.exec(w);
162 |       stem = fp[1];
163 |       re = new RegExp(mgr1);
164 |       if (re.test(stem))
165 |         w = stem;
166 |     }
167 |     else if (re2.test(w)) {
168 |       var fp = re2.exec(w);
169 |       stem = fp[1] + fp[2];
170 |       re2 = new RegExp(mgr1);
171 |       if (re2.test(stem))
172 |         w = stem;
173 |     }
174 | 
175 |     // Step 5
176 |     re = /^(.+?)e$/;
177 |     if (re.test(w)) {
178 |       var fp = re.exec(w);
179 |       stem = fp[1];
180 |       re = new RegExp(mgr1);
181 |       re2 = new RegExp(meq1);
182 |       re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
183 |       if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
184 |         w = stem;
185 |     }
186 |     re = /ll$/;
187 |     re2 = new RegExp(mgr1);
188 |     if (re.test(w) && re2.test(w)) {
189 |       re = /.$/;
190 |       w = w.replace(re,"");
191 |     }
192 | 
193 |     // and turn initial Y back to y
194 |     if (firstch == "y")
195 |       w = firstch.toLowerCase() + w.substr(1);
196 |     return w;
197 |   }
198 | }
199 | 
200 | 


--------------------------------------------------------------------------------
/docs/_build/singlehtml/_static/minus.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/devbisme/kinet2pcb/1ccad5d6df308126427aa7c3d0eafa693386e230/docs/_build/singlehtml/_static/minus.png


--------------------------------------------------------------------------------
/docs/_build/singlehtml/_static/plus.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/devbisme/kinet2pcb/1ccad5d6df308126427aa7c3d0eafa693386e230/docs/_build/singlehtml/_static/plus.png


--------------------------------------------------------------------------------
/docs/_build/singlehtml/_static/pygments.css:
--------------------------------------------------------------------------------
 1 | pre { line-height: 125%; }
 2 | td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
 3 | span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
 4 | td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 5 | span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 6 | .highlight .hll { background-color: #ffffcc }
 7 | .highlight { background: #eeffcc; }
 8 | .highlight .c { color: #408090; font-style: italic } /* Comment */
 9 | .highlight .err { border: 1px solid #FF0000 } /* Error */
10 | .highlight .k { color: #007020; font-weight: bold } /* Keyword */
11 | .highlight .o { color: #666666 } /* Operator */
12 | .highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */
13 | .highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
14 | .highlight .cp { color: #007020 } /* Comment.Preproc */
15 | .highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */
16 | .highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
17 | .highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
18 | .highlight .gd { color: #A00000 } /* Generic.Deleted */
19 | .highlight .ge { font-style: italic } /* Generic.Emph */
20 | .highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
21 | .highlight .gr { color: #FF0000 } /* Generic.Error */
22 | .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
23 | .highlight .gi { color: #00A000 } /* Generic.Inserted */
24 | .highlight .go { color: #333333 } /* Generic.Output */
25 | .highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
26 | .highlight .gs { font-weight: bold } /* Generic.Strong */
27 | .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
28 | .highlight .gt { color: #0044DD } /* Generic.Traceback */
29 | .highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
30 | .highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
31 | .highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
32 | .highlight .kp { color: #007020 } /* Keyword.Pseudo */
33 | .highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
34 | .highlight .kt { color: #902000 } /* Keyword.Type */
35 | .highlight .m { color: #208050 } /* Literal.Number */
36 | .highlight .s { color: #4070a0 } /* Literal.String */
37 | .highlight .na { color: #4070a0 } /* Name.Attribute */
38 | .highlight .nb { color: #007020 } /* Name.Builtin */
39 | .highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
40 | .highlight .no { color: #60add5 } /* Name.Constant */
41 | .highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
42 | .highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
43 | .highlight .ne { color: #007020 } /* Name.Exception */
44 | .highlight .nf { color: #06287e } /* Name.Function */
45 | .highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
46 | .highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
47 | .highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
48 | .highlight .nv { color: #bb60d5 } /* Name.Variable */
49 | .highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
50 | .highlight .w { color: #bbbbbb } /* Text.Whitespace */
51 | .highlight .mb { color: #208050 } /* Literal.Number.Bin */
52 | .highlight .mf { color: #208050 } /* Literal.Number.Float */
53 | .highlight .mh { color: #208050 } /* Literal.Number.Hex */
54 | .highlight .mi { color: #208050 } /* Literal.Number.Integer */
55 | .highlight .mo { color: #208050 } /* Literal.Number.Oct */
56 | .highlight .sa { color: #4070a0 } /* Literal.String.Affix */
57 | .highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
58 | .highlight .sc { color: #4070a0 } /* Literal.String.Char */
59 | .highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */
60 | .highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
61 | .highlight .s2 { color: #4070a0 } /* Literal.String.Double */
62 | .highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
63 | .highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
64 | .highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
65 | .highlight .sx { color: #c65d09 } /* Literal.String.Other */
66 | .highlight .sr { color: #235388 } /* Literal.String.Regex */
67 | .highlight .s1 { color: #4070a0 } /* Literal.String.Single */
68 | .highlight .ss { color: #517918 } /* Literal.String.Symbol */
69 | .highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
70 | .highlight .fm { color: #06287e } /* Name.Function.Magic */
71 | .highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
72 | .highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
73 | .highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
74 | .highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */
75 | .highlight .il { color: #208050 } /* Literal.Number.Integer.Long */


--------------------------------------------------------------------------------
/docs/_build/singlehtml/_static/searchtools.js:
--------------------------------------------------------------------------------
  1 | /*
  2 |  * searchtools.js
  3 |  * ~~~~~~~~~~~~~~~~
  4 |  *
  5 |  * Sphinx JavaScript utilities for the full-text search.
  6 |  *
  7 |  * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
  8 |  * :license: BSD, see LICENSE for details.
  9 |  *
 10 |  */
 11 | "use strict";
 12 | 
 13 | /**
 14 |  * Simple result scoring code.
 15 |  */
 16 | if (typeof Scorer === "undefined") {
 17 |   var Scorer = {
 18 |     // Implement the following function to further tweak the score for each result
 19 |     // The function takes a result array [docname, title, anchor, descr, score, filename]
 20 |     // and returns the new score.
 21 |     /*
 22 |     score: result => {
 23 |       const [docname, title, anchor, descr, score, filename] = result
 24 |       return score
 25 |     },
 26 |     */
 27 | 
 28 |     // query matches the full name of an object
 29 |     objNameMatch: 11,
 30 |     // or matches in the last dotted part of the object name
 31 |     objPartialMatch: 6,
 32 |     // Additive scores depending on the priority of the object
 33 |     objPrio: {
 34 |       0: 15, // used to be importantResults
 35 |       1: 5, // used to be objectResults
 36 |       2: -5, // used to be unimportantResults
 37 |     },
 38 |     //  Used when the priority is not in the mapping.
 39 |     objPrioDefault: 0,
 40 | 
 41 |     // query found in title
 42 |     title: 15,
 43 |     partialTitle: 7,
 44 |     // query found in terms
 45 |     term: 5,
 46 |     partialTerm: 2,
 47 |   };
 48 | }
 49 | 
 50 | const _removeChildren = (element) => {
 51 |   while (element && element.lastChild) element.removeChild(element.lastChild);
 52 | };
 53 | 
 54 | /**
 55 |  * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping
 56 |  */
 57 | const _escapeRegExp = (string) =>
 58 |   string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
 59 | 
 60 | const _displayItem = (item, highlightTerms, searchTerms) => {
 61 |   const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
 62 |   const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT;
 63 |   const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
 64 |   const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
 65 |   const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
 66 | 
 67 |   const [docName, title, anchor, descr] = item;
 68 | 
 69 |   let listItem = document.createElement("li");
 70 |   let requestUrl;
 71 |   let linkUrl;
 72 |   if (docBuilder === "dirhtml") {
 73 |     // dirhtml builder
 74 |     let dirname = docName + "/";
 75 |     if (dirname.match(/\/index\/$/))
 76 |       dirname = dirname.substring(0, dirname.length - 6);
 77 |     else if (dirname === "index/") dirname = "";
 78 |     requestUrl = docUrlRoot + dirname;
 79 |     linkUrl = requestUrl;
 80 |   } else {
 81 |     // normal html builders
 82 |     requestUrl = docUrlRoot + docName + docFileSuffix;
 83 |     linkUrl = docName + docLinkSuffix;
 84 |   }
 85 |   const params = new URLSearchParams();
 86 |   params.set("highlight", [...highlightTerms].join(" "));
 87 |   let linkEl = listItem.appendChild(document.createElement("a"));
 88 |   linkEl.href = linkUrl + "?" + params.toString() + anchor;
 89 |   linkEl.innerHTML = title;
 90 |   if (descr)
 91 |     listItem.appendChild(document.createElement("span")).innerText =
 92 |       " (" + descr + ")";
 93 |   else if (showSearchSummary)
 94 |     fetch(requestUrl)
 95 |       .then((responseData) => responseData.text())
 96 |       .then((data) => {
 97 |         if (data)
 98 |           listItem.appendChild(
 99 |             Search.makeSearchSummary(data, searchTerms, highlightTerms)
100 |           );
101 |       });
102 |   Search.output.appendChild(listItem);
103 | };
104 | const _finishSearch = (resultCount) => {
105 |   Search.stopPulse();
106 |   Search.title.innerText = _("Search Results");
107 |   if (!resultCount)
108 |     Search.status.innerText = Documentation.gettext(
109 |       "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories."
110 |     );
111 |   else
112 |     Search.status.innerText = _(
113 |       `Search finished, found ${resultCount} page(s) matching the search query.`
114 |     );
115 | };
116 | const _displayNextItem = (
117 |   results,
118 |   resultCount,
119 |   highlightTerms,
120 |   searchTerms
121 | ) => {
122 |   // results left, load the summary and display it
123 |   // this is intended to be dynamic (don't sub resultsCount)
124 |   if (results.length) {
125 |     _displayItem(results.pop(), highlightTerms, searchTerms);
126 |     setTimeout(
127 |       () => _displayNextItem(results, resultCount, highlightTerms, searchTerms),
128 |       5
129 |     );
130 |   }
131 |   // search finished, update title and status message
132 |   else _finishSearch(resultCount);
133 | };
134 | 
135 | /**
136 |  * Default splitQuery function. Can be overridden in ``sphinx.search`` with a
137 |  * custom function per language.
138 |  *
139 |  * The regular expression works by splitting the string on consecutive characters
140 |  * that are not Unicode letters, numbers, underscores, or emoji characters.
141 |  * This is the same as ``\W+`` in Python, preserving the surrogate pair area.
142 |  */
143 | if (typeof splitQuery === "undefined") {
144 |   var splitQuery = (query) => query
145 |       .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu)
146 |       .filter(term => term)  // remove remaining empty strings
147 | }
148 | 
149 | /**
150 |  * Search Module
151 |  */
152 | const Search = {
153 |   _index: null,
154 |   _queued_query: null,
155 |   _pulse_status: -1,
156 | 
157 |   htmlToText: (htmlString) => {
158 |     const htmlElement = document
159 |       .createRange()
160 |       .createContextualFragment(htmlString);
161 |     _removeChildren(htmlElement.querySelectorAll(".headerlink"));
162 |     const docContent = htmlElement.querySelector('[role="main"]');
163 |     if (docContent !== undefined) return docContent.textContent;
164 |     console.warn(
165 |       "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template."
166 |     );
167 |     return "";
168 |   },
169 | 
170 |   init: () => {
171 |     const query = new URLSearchParams(window.location.search).get("q");
172 |     document
173 |       .querySelectorAll('input[name="q"]')
174 |       .forEach((el) => (el.value = query));
175 |     if (query) Search.performSearch(query);
176 |   },
177 | 
178 |   loadIndex: (url) =>
179 |     (document.body.appendChild(document.createElement("script")).src = url),
180 | 
181 |   setIndex: (index) => {
182 |     Search._index = index;
183 |     if (Search._queued_query !== null) {
184 |       const query = Search._queued_query;
185 |       Search._queued_query = null;
186 |       Search.query(query);
187 |     }
188 |   },
189 | 
190 |   hasIndex: () => Search._index !== null,
191 | 
192 |   deferQuery: (query) => (Search._queued_query = query),
193 | 
194 |   stopPulse: () => (Search._pulse_status = -1),
195 | 
196 |   startPulse: () => {
197 |     if (Search._pulse_status >= 0) return;
198 | 
199 |     const pulse = () => {
200 |       Search._pulse_status = (Search._pulse_status + 1) % 4;
201 |       Search.dots.innerText = ".".repeat(Search._pulse_status);
202 |       if (Search._pulse_status >= 0) window.setTimeout(pulse, 500);
203 |     };
204 |     pulse();
205 |   },
206 | 
207 |   /**
208 |    * perform a search for something (or wait until index is loaded)
209 |    */
210 |   performSearch: (query) => {
211 |     // create the required interface elements
212 |     const searchText = document.createElement("h2");
213 |     searchText.textContent = _("Searching");
214 |     const searchSummary = document.createElement("p");
215 |     searchSummary.classList.add("search-summary");
216 |     searchSummary.innerText = "";
217 |     const searchList = document.createElement("ul");
218 |     searchList.classList.add("search");
219 | 
220 |     const out = document.getElementById("search-results");
221 |     Search.title = out.appendChild(searchText);
222 |     Search.dots = Search.title.appendChild(document.createElement("span"));
223 |     Search.status = out.appendChild(searchSummary);
224 |     Search.output = out.appendChild(searchList);
225 | 
226 |     const searchProgress = document.getElementById("search-progress");
227 |     // Some themes don't use the search progress node
228 |     if (searchProgress) {
229 |       searchProgress.innerText = _("Preparing search...");
230 |     }
231 |     Search.startPulse();
232 | 
233 |     // index already loaded, the browser was quick!
234 |     if (Search.hasIndex()) Search.query(query);
235 |     else Search.deferQuery(query);
236 |   },
237 | 
238 |   /**
239 |    * execute search (requires search index to be loaded)
240 |    */
241 |   query: (query) => {
242 |     // stem the search terms and add them to the correct list
243 |     const stemmer = new Stemmer();
244 |     const searchTerms = new Set();
245 |     const excludedTerms = new Set();
246 |     const highlightTerms = new Set();
247 |     const objectTerms = new Set(splitQuery(query.toLowerCase().trim()));
248 |     splitQuery(query.trim()).forEach((queryTerm) => {
249 |       const queryTermLower = queryTerm.toLowerCase();
250 | 
251 |       // maybe skip this "word"
252 |       // stopwords array is from language_data.js
253 |       if (
254 |         stopwords.indexOf(queryTermLower) !== -1 ||
255 |         queryTerm.match(/^\d+$/)
256 |       )
257 |         return;
258 | 
259 |       // stem the word
260 |       let word = stemmer.stemWord(queryTermLower);
261 |       // select the correct list
262 |       if (word[0] === "-") excludedTerms.add(word.substr(1));
263 |       else {
264 |         searchTerms.add(word);
265 |         highlightTerms.add(queryTermLower);
266 |       }
267 |     });
268 | 
269 |     // console.debug("SEARCH: searching for:");
270 |     // console.info("required: ", [...searchTerms]);
271 |     // console.info("excluded: ", [...excludedTerms]);
272 | 
273 |     // array of [docname, title, anchor, descr, score, filename]
274 |     let results = [];
275 |     _removeChildren(document.getElementById("search-progress"));
276 | 
277 |     // lookup as object
278 |     objectTerms.forEach((term) =>
279 |       results.push(...Search.performObjectSearch(term, objectTerms))
280 |     );
281 | 
282 |     // lookup as search terms in fulltext
283 |     results.push(...Search.performTermsSearch(searchTerms, excludedTerms));
284 | 
285 |     // let the scorer override scores with a custom scoring function
286 |     if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item)));
287 | 
288 |     // now sort the results by score (in opposite order of appearance, since the
289 |     // display function below uses pop() to retrieve items) and then
290 |     // alphabetically
291 |     results.sort((a, b) => {
292 |       const leftScore = a[4];
293 |       const rightScore = b[4];
294 |       if (leftScore === rightScore) {
295 |         // same score: sort alphabetically
296 |         const leftTitle = a[1].toLowerCase();
297 |         const rightTitle = b[1].toLowerCase();
298 |         if (leftTitle === rightTitle) return 0;
299 |         return leftTitle > rightTitle ? -1 : 1; // inverted is intentional
300 |       }
301 |       return leftScore > rightScore ? 1 : -1;
302 |     });
303 | 
304 |     // remove duplicate search results
305 |     // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept
306 |     let seen = new Set();
307 |     results = results.reverse().reduce((acc, result) => {
308 |       let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(',');
309 |       if (!seen.has(resultStr)) {
310 |         acc.push(result);
311 |         seen.add(resultStr);
312 |       }
313 |       return acc;
314 |     }, []);
315 | 
316 |     results = results.reverse();
317 | 
318 |     // for debugging
319 |     //Search.lastresults = results.slice();  // a copy
320 |     // console.info("search results:", Search.lastresults);
321 | 
322 |     // print the results
323 |     _displayNextItem(results, results.length, highlightTerms, searchTerms);
324 |   },
325 | 
326 |   /**
327 |    * search for object names
328 |    */
329 |   performObjectSearch: (object, objectTerms) => {
330 |     const filenames = Search._index.filenames;
331 |     const docNames = Search._index.docnames;
332 |     const objects = Search._index.objects;
333 |     const objNames = Search._index.objnames;
334 |     const titles = Search._index.titles;
335 | 
336 |     const results = [];
337 | 
338 |     const objectSearchCallback = (prefix, match) => {
339 |       const name = match[4]
340 |       const fullname = (prefix ? prefix + "." : "") + name;
341 |       const fullnameLower = fullname.toLowerCase();
342 |       if (fullnameLower.indexOf(object) < 0) return;
343 | 
344 |       let score = 0;
345 |       const parts = fullnameLower.split(".");
346 | 
347 |       // check for different match types: exact matches of full name or
348 |       // "last name" (i.e. last dotted part)
349 |       if (fullnameLower === object || parts.slice(-1)[0] === object)
350 |         score += Scorer.objNameMatch;
351 |       else if (parts.slice(-1)[0].indexOf(object) > -1)
352 |         score += Scorer.objPartialMatch; // matches in last name
353 | 
354 |       const objName = objNames[match[1]][2];
355 |       const title = titles[match[0]];
356 | 
357 |       // If more than one term searched for, we require other words to be
358 |       // found in the name/title/description
359 |       const otherTerms = new Set(objectTerms);
360 |       otherTerms.delete(object);
361 |       if (otherTerms.size > 0) {
362 |         const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase();
363 |         if (
364 |           [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0)
365 |         )
366 |           return;
367 |       }
368 | 
369 |       let anchor = match[3];
370 |       if (anchor === "") anchor = fullname;
371 |       else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname;
372 | 
373 |       const descr = objName + _(", in ") + title;
374 | 
375 |       // add custom score for some objects according to scorer
376 |       if (Scorer.objPrio.hasOwnProperty(match[2]))
377 |         score += Scorer.objPrio[match[2]];
378 |       else score += Scorer.objPrioDefault;
379 | 
380 |       results.push([
381 |         docNames[match[0]],
382 |         fullname,
383 |         "#" + anchor,
384 |         descr,
385 |         score,
386 |         filenames[match[0]],
387 |       ]);
388 |     };
389 |     Object.keys(objects).forEach((prefix) =>
390 |       objects[prefix].forEach((array) =>
391 |         objectSearchCallback(prefix, array)
392 |       )
393 |     );
394 |     return results;
395 |   },
396 | 
397 |   /**
398 |    * search for full-text terms in the index
399 |    */
400 |   performTermsSearch: (searchTerms, excludedTerms) => {
401 |     // prepare search
402 |     const terms = Search._index.terms;
403 |     const titleTerms = Search._index.titleterms;
404 |     const docNames = Search._index.docnames;
405 |     const filenames = Search._index.filenames;
406 |     const titles = Search._index.titles;
407 | 
408 |     const scoreMap = new Map();
409 |     const fileMap = new Map();
410 | 
411 |     // perform the search on the required terms
412 |     searchTerms.forEach((word) => {
413 |       const files = [];
414 |       const arr = [
415 |         { files: terms[word], score: Scorer.term },
416 |         { files: titleTerms[word], score: Scorer.title },
417 |       ];
418 |       // add support for partial matches
419 |       if (word.length > 2) {
420 |         const escapedWord = _escapeRegExp(word);
421 |         Object.keys(terms).forEach((term) => {
422 |           if (term.match(escapedWord) && !terms[word])
423 |             arr.push({ files: terms[term], score: Scorer.partialTerm });
424 |         });
425 |         Object.keys(titleTerms).forEach((term) => {
426 |           if (term.match(escapedWord) && !titleTerms[word])
427 |             arr.push({ files: titleTerms[word], score: Scorer.partialTitle });
428 |         });
429 |       }
430 | 
431 |       // no match but word was a required one
432 |       if (arr.every((record) => record.files === undefined)) return;
433 | 
434 |       // found search word in contents
435 |       arr.forEach((record) => {
436 |         if (record.files === undefined) return;
437 | 
438 |         let recordFiles = record.files;
439 |         if (recordFiles.length === undefined) recordFiles = [recordFiles];
440 |         files.push(...recordFiles);
441 | 
442 |         // set score for the word in each file
443 |         recordFiles.forEach((file) => {
444 |           if (!scoreMap.has(file)) scoreMap.set(file, {});
445 |           scoreMap.get(file)[word] = record.score;
446 |         });
447 |       });
448 | 
449 |       // create the mapping
450 |       files.forEach((file) => {
451 |         if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1)
452 |           fileMap.get(file).push(word);
453 |         else fileMap.set(file, [word]);
454 |       });
455 |     });
456 | 
457 |     // now check if the files don't contain excluded terms
458 |     const results = [];
459 |     for (const [file, wordList] of fileMap) {
460 |       // check if all requirements are matched
461 | 
462 |       // as search terms with length < 3 are discarded
463 |       const filteredTermCount = [...searchTerms].filter(
464 |         (term) => term.length > 2
465 |       ).length;
466 |       if (
467 |         wordList.length !== searchTerms.size &&
468 |         wordList.length !== filteredTermCount
469 |       )
470 |         continue;
471 | 
472 |       // ensure that none of the excluded terms is in the search result
473 |       if (
474 |         [...excludedTerms].some(
475 |           (term) =>
476 |             terms[term] === file ||
477 |             titleTerms[term] === file ||
478 |             (terms[term] || []).includes(file) ||
479 |             (titleTerms[term] || []).includes(file)
480 |         )
481 |       )
482 |         break;
483 | 
484 |       // select one (max) score for the file.
485 |       const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w]));
486 |       // add result to the result list
487 |       results.push([
488 |         docNames[file],
489 |         titles[file],
490 |         "",
491 |         null,
492 |         score,
493 |         filenames[file],
494 |       ]);
495 |     }
496 |     return results;
497 |   },
498 | 
499 |   /**
500 |    * helper function to return a node containing the
501 |    * search summary for a given text. keywords is a list
502 |    * of stemmed words, highlightWords is the list of normal, unstemmed
503 |    * words. the first one is used to find the occurrence, the
504 |    * latter for highlighting it.
505 |    */
506 |   makeSearchSummary: (htmlText, keywords, highlightWords) => {
507 |     const text = Search.htmlToText(htmlText).toLowerCase();
508 |     if (text === "") return null;
509 | 
510 |     const actualStartPosition = [...keywords]
511 |       .map((k) => text.indexOf(k.toLowerCase()))
512 |       .filter((i) => i > -1)
513 |       .slice(-1)[0];
514 |     const startWithContext = Math.max(actualStartPosition - 120, 0);
515 | 
516 |     const top = startWithContext === 0 ? "" : "...";
517 |     const tail = startWithContext + 240 < text.length ? "..." : "";
518 | 
519 |     let summary = document.createElement("div");
520 |     summary.classList.add("context");
521 |     summary.innerText = top + text.substr(startWithContext, 240).trim() + tail;
522 | 
523 |     highlightWords.forEach((highlightWord) =>
524 |       _highlightText(summary, highlightWord, "highlighted")
525 |     );
526 | 
527 |     return summary;
528 |   },
529 | };
530 | 
531 | _ready(Search.init);
532 | 


--------------------------------------------------------------------------------
/docs/_build/singlehtml/_static/underscore.js:
--------------------------------------------------------------------------------
1 | !function(n,r){"object"==typeof exports&&"undefined"!=typeof module?module.exports=r():"function"==typeof define&&define.amd?define("underscore",r):(n="undefined"!=typeof globalThis?globalThis:n||self,function(){var t=n._,e=n._=r();e.noConflict=function(){return n._=t,e}}())}(this,(function(){
2 | //     Underscore.js 1.13.1
3 | //     https://underscorejs.org
4 | //     (c) 2009-2021 Jeremy Ashkenas, Julian Gonggrijp, and DocumentCloud and Investigative Reporters & Editors
5 | //     Underscore may be freely distributed under the MIT license.
6 | var n="1.13.1",r="object"==typeof self&&self.self===self&&self||"object"==typeof global&&global.global===global&&global||Function("return this")()||{},t=Array.prototype,e=Object.prototype,u="undefined"!=typeof Symbol?Symbol.prototype:null,o=t.push,i=t.slice,a=e.toString,f=e.hasOwnProperty,c="undefined"!=typeof ArrayBuffer,l="undefined"!=typeof DataView,s=Array.isArray,p=Object.keys,v=Object.create,h=c&&ArrayBuffer.isView,y=isNaN,d=isFinite,g=!{toString:null}.propertyIsEnumerable("toString"),b=["valueOf","isPrototypeOf","toString","propertyIsEnumerable","hasOwnProperty","toLocaleString"],m=Math.pow(2,53)-1;function j(n,r){return r=null==r?n.length-1:+r,function(){for(var t=Math.max(arguments.length-r,0),e=Array(t),u=0;u<t;u++)e[u]=arguments[u+r];switch(r){case 0:return n.call(this,e);case 1:return n.call(this,arguments[0],e);case 2:return n.call(this,arguments[0],arguments[1],e)}var o=Array(r+1);for(u=0;u<r;u++)o[u]=arguments[u];return o[r]=e,n.apply(this,o)}}function _(n){var r=typeof n;return"function"===r||"object"===r&&!!n}function w(n){return void 0===n}function A(n){return!0===n||!1===n||"[object Boolean]"===a.call(n)}function x(n){var r="[object "+n+"]";return function(n){return a.call(n)===r}}var S=x("String"),O=x("Number"),M=x("Date"),E=x("RegExp"),B=x("Error"),N=x("Symbol"),I=x("ArrayBuffer"),T=x("Function"),k=r.document&&r.document.childNodes;"function"!=typeof/./&&"object"!=typeof Int8Array&&"function"!=typeof k&&(T=function(n){return"function"==typeof n||!1});var D=T,R=x("Object"),F=l&&R(new DataView(new ArrayBuffer(8))),V="undefined"!=typeof Map&&R(new Map),P=x("DataView");var q=F?function(n){return null!=n&&D(n.getInt8)&&I(n.buffer)}:P,U=s||x("Array");function W(n,r){return null!=n&&f.call(n,r)}var z=x("Arguments");!function(){z(arguments)||(z=function(n){return W(n,"callee")})}();var L=z;function $(n){return O(n)&&y(n)}function C(n){return function(){return n}}function K(n){return function(r){var t=n(r);return"number"==typeof t&&t>=0&&t<=m}}function J(n){return function(r){return null==r?void 0:r[n]}}var G=J("byteLength"),H=K(G),Q=/\[object ((I|Ui)nt(8|16|32)|Float(32|64)|Uint8Clamped|Big(I|Ui)nt64)Array\]/;var X=c?function(n){return h?h(n)&&!q(n):H(n)&&Q.test(a.call(n))}:C(!1),Y=J("length");function Z(n,r){r=function(n){for(var r={},t=n.length,e=0;e<t;++e)r[n[e]]=!0;return{contains:function(n){return r[n]},push:function(t){return r[t]=!0,n.push(t)}}}(r);var t=b.length,u=n.constructor,o=D(u)&&u.prototype||e,i="constructor";for(W(n,i)&&!r.contains(i)&&r.push(i);t--;)(i=b[t])in n&&n[i]!==o[i]&&!r.contains(i)&&r.push(i)}function nn(n){if(!_(n))return[];if(p)return p(n);var r=[];for(var t in n)W(n,t)&&r.push(t);return g&&Z(n,r),r}function rn(n,r){var t=nn(r),e=t.length;if(null==n)return!e;for(var u=Object(n),o=0;o<e;o++){var i=t[o];if(r[i]!==u[i]||!(i in u))return!1}return!0}function tn(n){return n instanceof tn?n:this instanceof tn?void(this._wrapped=n):new tn(n)}function en(n){return new Uint8Array(n.buffer||n,n.byteOffset||0,G(n))}tn.VERSION=n,tn.prototype.value=function(){return this._wrapped},tn.prototype.valueOf=tn.prototype.toJSON=tn.prototype.value,tn.prototype.toString=function(){return String(this._wrapped)};var un="[object DataView]";function on(n,r,t,e){if(n===r)return 0!==n||1/n==1/r;if(null==n||null==r)return!1;if(n!=n)return r!=r;var o=typeof n;return("function"===o||"object"===o||"object"==typeof r)&&function n(r,t,e,o){r instanceof tn&&(r=r._wrapped);t instanceof tn&&(t=t._wrapped);var i=a.call(r);if(i!==a.call(t))return!1;if(F&&"[object Object]"==i&&q(r)){if(!q(t))return!1;i=un}switch(i){case"[object RegExp]":case"[object String]":return""+r==""+t;case"[object Number]":return+r!=+r?+t!=+t:0==+r?1/+r==1/t:+r==+t;case"[object Date]":case"[object Boolean]":return+r==+t;case"[object Symbol]":return u.valueOf.call(r)===u.valueOf.call(t);case"[object ArrayBuffer]":case un:return n(en(r),en(t),e,o)}var f="[object Array]"===i;if(!f&&X(r)){if(G(r)!==G(t))return!1;if(r.buffer===t.buffer&&r.byteOffset===t.byteOffset)return!0;f=!0}if(!f){if("object"!=typeof r||"object"!=typeof t)return!1;var c=r.constructor,l=t.constructor;if(c!==l&&!(D(c)&&c instanceof c&&D(l)&&l instanceof l)&&"constructor"in r&&"constructor"in t)return!1}o=o||[];var s=(e=e||[]).length;for(;s--;)if(e[s]===r)return o[s]===t;if(e.push(r),o.push(t),f){if((s=r.length)!==t.length)return!1;for(;s--;)if(!on(r[s],t[s],e,o))return!1}else{var p,v=nn(r);if(s=v.length,nn(t).length!==s)return!1;for(;s--;)if(p=v[s],!W(t,p)||!on(r[p],t[p],e,o))return!1}return e.pop(),o.pop(),!0}(n,r,t,e)}function an(n){if(!_(n))return[];var r=[];for(var t in n)r.push(t);return g&&Z(n,r),r}function fn(n){var r=Y(n);return function(t){if(null==t)return!1;var e=an(t);if(Y(e))return!1;for(var u=0;u<r;u++)if(!D(t[n[u]]))return!1;return n!==hn||!D(t[cn])}}var cn="forEach",ln="has",sn=["clear","delete"],pn=["get",ln,"set"],vn=sn.concat(cn,pn),hn=sn.concat(pn),yn=["add"].concat(sn,cn,ln),dn=V?fn(vn):x("Map"),gn=V?fn(hn):x("WeakMap"),bn=V?fn(yn):x("Set"),mn=x("WeakSet");function jn(n){for(var r=nn(n),t=r.length,e=Array(t),u=0;u<t;u++)e[u]=n[r[u]];return e}function _n(n){for(var r={},t=nn(n),e=0,u=t.length;e<u;e++)r[n[t[e]]]=t[e];return r}function wn(n){var r=[];for(var t in n)D(n[t])&&r.push(t);return r.sort()}function An(n,r){return function(t){var e=arguments.length;if(r&&(t=Object(t)),e<2||null==t)return t;for(var u=1;u<e;u++)for(var o=arguments[u],i=n(o),a=i.length,f=0;f<a;f++){var c=i[f];r&&void 0!==t[c]||(t[c]=o[c])}return t}}var xn=An(an),Sn=An(nn),On=An(an,!0);function Mn(n){if(!_(n))return{};if(v)return v(n);var r=function(){};r.prototype=n;var t=new r;return r.prototype=null,t}function En(n){return _(n)?U(n)?n.slice():xn({},n):n}function Bn(n){return U(n)?n:[n]}function Nn(n){return tn.toPath(n)}function In(n,r){for(var t=r.length,e=0;e<t;e++){if(null==n)return;n=n[r[e]]}return t?n:void 0}function Tn(n,r,t){var e=In(n,Nn(r));return w(e)?t:e}function kn(n){return n}function Dn(n){return n=Sn({},n),function(r){return rn(r,n)}}function Rn(n){return n=Nn(n),function(r){return In(r,n)}}function Fn(n,r,t){if(void 0===r)return n;switch(null==t?3:t){case 1:return function(t){return n.call(r,t)};case 3:return function(t,e,u){return n.call(r,t,e,u)};case 4:return function(t,e,u,o){return n.call(r,t,e,u,o)}}return function(){return n.apply(r,arguments)}}function Vn(n,r,t){return null==n?kn:D(n)?Fn(n,r,t):_(n)&&!U(n)?Dn(n):Rn(n)}function Pn(n,r){return Vn(n,r,1/0)}function qn(n,r,t){return tn.iteratee!==Pn?tn.iteratee(n,r):Vn(n,r,t)}function Un(){}function Wn(n,r){return null==r&&(r=n,n=0),n+Math.floor(Math.random()*(r-n+1))}tn.toPath=Bn,tn.iteratee=Pn;var zn=Date.now||function(){return(new Date).getTime()};function Ln(n){var r=function(r){return n[r]},t="(?:"+nn(n).join("|")+")",e=RegExp(t),u=RegExp(t,"g");return function(n){return n=null==n?"":""+n,e.test(n)?n.replace(u,r):n}}var $n={"&":"&amp;","<":"&lt;",">":"&gt;",'"':"&quot;","'":"&#x27;","`":"&#x60;"},Cn=Ln($n),Kn=Ln(_n($n)),Jn=tn.templateSettings={evaluate:/<%([\s\S]+?)%>/g,interpolate:/<%=([\s\S]+?)%>/g,escape:/<%-([\s\S]+?)%>/g},Gn=/(.)^/,Hn={"'":"'","\\":"\\","\r":"r","\n":"n","\u2028":"u2028","\u2029":"u2029"},Qn=/\\|'|\r|\n|\u2028|\u2029/g;function Xn(n){return"\\"+Hn[n]}var Yn=/^\s*(\w|\$)+\s*$/;var Zn=0;function nr(n,r,t,e,u){if(!(e instanceof r))return n.apply(t,u);var o=Mn(n.prototype),i=n.apply(o,u);return _(i)?i:o}var rr=j((function(n,r){var t=rr.placeholder,e=function(){for(var u=0,o=r.length,i=Array(o),a=0;a<o;a++)i[a]=r[a]===t?arguments[u++]:r[a];for(;u<arguments.length;)i.push(arguments[u++]);return nr(n,e,this,this,i)};return e}));rr.placeholder=tn;var tr=j((function(n,r,t){if(!D(n))throw new TypeError("Bind must be called on a function");var e=j((function(u){return nr(n,e,r,this,t.concat(u))}));return e})),er=K(Y);function ur(n,r,t,e){if(e=e||[],r||0===r){if(r<=0)return e.concat(n)}else r=1/0;for(var u=e.length,o=0,i=Y(n);o<i;o++){var a=n[o];if(er(a)&&(U(a)||L(a)))if(r>1)ur(a,r-1,t,e),u=e.length;else for(var f=0,c=a.length;f<c;)e[u++]=a[f++];else t||(e[u++]=a)}return e}var or=j((function(n,r){var t=(r=ur(r,!1,!1)).length;if(t<1)throw new Error("bindAll must be passed function names");for(;t--;){var e=r[t];n[e]=tr(n[e],n)}return n}));var ir=j((function(n,r,t){return setTimeout((function(){return n.apply(null,t)}),r)})),ar=rr(ir,tn,1);function fr(n){return function(){return!n.apply(this,arguments)}}function cr(n,r){var t;return function(){return--n>0&&(t=r.apply(this,arguments)),n<=1&&(r=null),t}}var lr=rr(cr,2);function sr(n,r,t){r=qn(r,t);for(var e,u=nn(n),o=0,i=u.length;o<i;o++)if(r(n[e=u[o]],e,n))return e}function pr(n){return function(r,t,e){t=qn(t,e);for(var u=Y(r),o=n>0?0:u-1;o>=0&&o<u;o+=n)if(t(r[o],o,r))return o;return-1}}var vr=pr(1),hr=pr(-1);function yr(n,r,t,e){for(var u=(t=qn(t,e,1))(r),o=0,i=Y(n);o<i;){var a=Math.floor((o+i)/2);t(n[a])<u?o=a+1:i=a}return o}function dr(n,r,t){return function(e,u,o){var a=0,f=Y(e);if("number"==typeof o)n>0?a=o>=0?o:Math.max(o+f,a):f=o>=0?Math.min(o+1,f):o+f+1;else if(t&&o&&f)return e[o=t(e,u)]===u?o:-1;if(u!=u)return(o=r(i.call(e,a,f),$))>=0?o+a:-1;for(o=n>0?a:f-1;o>=0&&o<f;o+=n)if(e[o]===u)return o;return-1}}var gr=dr(1,vr,yr),br=dr(-1,hr);function mr(n,r,t){var e=(er(n)?vr:sr)(n,r,t);if(void 0!==e&&-1!==e)return n[e]}function jr(n,r,t){var e,u;if(r=Fn(r,t),er(n))for(e=0,u=n.length;e<u;e++)r(n[e],e,n);else{var o=nn(n);for(e=0,u=o.length;e<u;e++)r(n[o[e]],o[e],n)}return n}function _r(n,r,t){r=qn(r,t);for(var e=!er(n)&&nn(n),u=(e||n).length,o=Array(u),i=0;i<u;i++){var a=e?e[i]:i;o[i]=r(n[a],a,n)}return o}function wr(n){var r=function(r,t,e,u){var o=!er(r)&&nn(r),i=(o||r).length,a=n>0?0:i-1;for(u||(e=r[o?o[a]:a],a+=n);a>=0&&a<i;a+=n){var f=o?o[a]:a;e=t(e,r[f],f,r)}return e};return function(n,t,e,u){var o=arguments.length>=3;return r(n,Fn(t,u,4),e,o)}}var Ar=wr(1),xr=wr(-1);function Sr(n,r,t){var e=[];return r=qn(r,t),jr(n,(function(n,t,u){r(n,t,u)&&e.push(n)})),e}function Or(n,r,t){r=qn(r,t);for(var e=!er(n)&&nn(n),u=(e||n).length,o=0;o<u;o++){var i=e?e[o]:o;if(!r(n[i],i,n))return!1}return!0}function Mr(n,r,t){r=qn(r,t);for(var e=!er(n)&&nn(n),u=(e||n).length,o=0;o<u;o++){var i=e?e[o]:o;if(r(n[i],i,n))return!0}return!1}function Er(n,r,t,e){return er(n)||(n=jn(n)),("number"!=typeof t||e)&&(t=0),gr(n,r,t)>=0}var Br=j((function(n,r,t){var e,u;return D(r)?u=r:(r=Nn(r),e=r.slice(0,-1),r=r[r.length-1]),_r(n,(function(n){var o=u;if(!o){if(e&&e.length&&(n=In(n,e)),null==n)return;o=n[r]}return null==o?o:o.apply(n,t)}))}));function Nr(n,r){return _r(n,Rn(r))}function Ir(n,r,t){var e,u,o=-1/0,i=-1/0;if(null==r||"number"==typeof r&&"object"!=typeof n[0]&&null!=n)for(var a=0,f=(n=er(n)?n:jn(n)).length;a<f;a++)null!=(e=n[a])&&e>o&&(o=e);else r=qn(r,t),jr(n,(function(n,t,e){((u=r(n,t,e))>i||u===-1/0&&o===-1/0)&&(o=n,i=u)}));return o}function Tr(n,r,t){if(null==r||t)return er(n)||(n=jn(n)),n[Wn(n.length-1)];var e=er(n)?En(n):jn(n),u=Y(e);r=Math.max(Math.min(r,u),0);for(var o=u-1,i=0;i<r;i++){var a=Wn(i,o),f=e[i];e[i]=e[a],e[a]=f}return e.slice(0,r)}function kr(n,r){return function(t,e,u){var o=r?[[],[]]:{};return e=qn(e,u),jr(t,(function(r,u){var i=e(r,u,t);n(o,r,i)})),o}}var Dr=kr((function(n,r,t){W(n,t)?n[t].push(r):n[t]=[r]})),Rr=kr((function(n,r,t){n[t]=r})),Fr=kr((function(n,r,t){W(n,t)?n[t]++:n[t]=1})),Vr=kr((function(n,r,t){n[t?0:1].push(r)}),!0),Pr=/[^\ud800-\udfff]|[\ud800-\udbff][\udc00-\udfff]|[\ud800-\udfff]/g;function qr(n,r,t){return r in t}var Ur=j((function(n,r){var t={},e=r[0];if(null==n)return t;D(e)?(r.length>1&&(e=Fn(e,r[1])),r=an(n)):(e=qr,r=ur(r,!1,!1),n=Object(n));for(var u=0,o=r.length;u<o;u++){var i=r[u],a=n[i];e(a,i,n)&&(t[i]=a)}return t})),Wr=j((function(n,r){var t,e=r[0];return D(e)?(e=fr(e),r.length>1&&(t=r[1])):(r=_r(ur(r,!1,!1),String),e=function(n,t){return!Er(r,t)}),Ur(n,e,t)}));function zr(n,r,t){return i.call(n,0,Math.max(0,n.length-(null==r||t?1:r)))}function Lr(n,r,t){return null==n||n.length<1?null==r||t?void 0:[]:null==r||t?n[0]:zr(n,n.length-r)}function $r(n,r,t){return i.call(n,null==r||t?1:r)}var Cr=j((function(n,r){return r=ur(r,!0,!0),Sr(n,(function(n){return!Er(r,n)}))})),Kr=j((function(n,r){return Cr(n,r)}));function Jr(n,r,t,e){A(r)||(e=t,t=r,r=!1),null!=t&&(t=qn(t,e));for(var u=[],o=[],i=0,a=Y(n);i<a;i++){var f=n[i],c=t?t(f,i,n):f;r&&!t?(i&&o===c||u.push(f),o=c):t?Er(o,c)||(o.push(c),u.push(f)):Er(u,f)||u.push(f)}return u}var Gr=j((function(n){return Jr(ur(n,!0,!0))}));function Hr(n){for(var r=n&&Ir(n,Y).length||0,t=Array(r),e=0;e<r;e++)t[e]=Nr(n,e);return t}var Qr=j(Hr);function Xr(n,r){return n._chain?tn(r).chain():r}function Yr(n){return jr(wn(n),(function(r){var t=tn[r]=n[r];tn.prototype[r]=function(){var n=[this._wrapped];return o.apply(n,arguments),Xr(this,t.apply(tn,n))}})),tn}jr(["pop","push","reverse","shift","sort","splice","unshift"],(function(n){var r=t[n];tn.prototype[n]=function(){var t=this._wrapped;return null!=t&&(r.apply(t,arguments),"shift"!==n&&"splice"!==n||0!==t.length||delete t[0]),Xr(this,t)}})),jr(["concat","join","slice"],(function(n){var r=t[n];tn.prototype[n]=function(){var n=this._wrapped;return null!=n&&(n=r.apply(n,arguments)),Xr(this,n)}}));var Zr=Yr({__proto__:null,VERSION:n,restArguments:j,isObject:_,isNull:function(n){return null===n},isUndefined:w,isBoolean:A,isElement:function(n){return!(!n||1!==n.nodeType)},isString:S,isNumber:O,isDate:M,isRegExp:E,isError:B,isSymbol:N,isArrayBuffer:I,isDataView:q,isArray:U,isFunction:D,isArguments:L,isFinite:function(n){return!N(n)&&d(n)&&!isNaN(parseFloat(n))},isNaN:$,isTypedArray:X,isEmpty:function(n){if(null==n)return!0;var r=Y(n);return"number"==typeof r&&(U(n)||S(n)||L(n))?0===r:0===Y(nn(n))},isMatch:rn,isEqual:function(n,r){return on(n,r)},isMap:dn,isWeakMap:gn,isSet:bn,isWeakSet:mn,keys:nn,allKeys:an,values:jn,pairs:function(n){for(var r=nn(n),t=r.length,e=Array(t),u=0;u<t;u++)e[u]=[r[u],n[r[u]]];return e},invert:_n,functions:wn,methods:wn,extend:xn,extendOwn:Sn,assign:Sn,defaults:On,create:function(n,r){var t=Mn(n);return r&&Sn(t,r),t},clone:En,tap:function(n,r){return r(n),n},get:Tn,has:function(n,r){for(var t=(r=Nn(r)).length,e=0;e<t;e++){var u=r[e];if(!W(n,u))return!1;n=n[u]}return!!t},mapObject:function(n,r,t){r=qn(r,t);for(var e=nn(n),u=e.length,o={},i=0;i<u;i++){var a=e[i];o[a]=r(n[a],a,n)}return o},identity:kn,constant:C,noop:Un,toPath:Bn,property:Rn,propertyOf:function(n){return null==n?Un:function(r){return Tn(n,r)}},matcher:Dn,matches:Dn,times:function(n,r,t){var e=Array(Math.max(0,n));r=Fn(r,t,1);for(var u=0;u<n;u++)e[u]=r(u);return e},random:Wn,now:zn,escape:Cn,unescape:Kn,templateSettings:Jn,template:function(n,r,t){!r&&t&&(r=t),r=On({},r,tn.templateSettings);var e=RegExp([(r.escape||Gn).source,(r.interpolate||Gn).source,(r.evaluate||Gn).source].join("|")+"|$","g"),u=0,o="__p+='";n.replace(e,(function(r,t,e,i,a){return o+=n.slice(u,a).replace(Qn,Xn),u=a+r.length,t?o+="'+\n((__t=("+t+"))==null?'':_.escape(__t))+\n'":e?o+="'+\n((__t=("+e+"))==null?'':__t)+\n'":i&&(o+="';\n"+i+"\n__p+='"),r})),o+="';\n";var i,a=r.variable;if(a){if(!Yn.test(a))throw new Error("variable is not a bare identifier: "+a)}else o="with(obj||{}){\n"+o+"}\n",a="obj";o="var __t,__p='',__j=Array.prototype.join,"+"print=function(){__p+=__j.call(arguments,'');};\n"+o+"return __p;\n";try{i=new Function(a,"_",o)}catch(n){throw n.source=o,n}var f=function(n){return i.call(this,n,tn)};return f.source="function("+a+"){\n"+o+"}",f},result:function(n,r,t){var e=(r=Nn(r)).length;if(!e)return D(t)?t.call(n):t;for(var u=0;u<e;u++){var o=null==n?void 0:n[r[u]];void 0===o&&(o=t,u=e),n=D(o)?o.call(n):o}return n},uniqueId:function(n){var r=++Zn+"";return n?n+r:r},chain:function(n){var r=tn(n);return r._chain=!0,r},iteratee:Pn,partial:rr,bind:tr,bindAll:or,memoize:function(n,r){var t=function(e){var u=t.cache,o=""+(r?r.apply(this,arguments):e);return W(u,o)||(u[o]=n.apply(this,arguments)),u[o]};return t.cache={},t},delay:ir,defer:ar,throttle:function(n,r,t){var e,u,o,i,a=0;t||(t={});var f=function(){a=!1===t.leading?0:zn(),e=null,i=n.apply(u,o),e||(u=o=null)},c=function(){var c=zn();a||!1!==t.leading||(a=c);var l=r-(c-a);return u=this,o=arguments,l<=0||l>r?(e&&(clearTimeout(e),e=null),a=c,i=n.apply(u,o),e||(u=o=null)):e||!1===t.trailing||(e=setTimeout(f,l)),i};return c.cancel=function(){clearTimeout(e),a=0,e=u=o=null},c},debounce:function(n,r,t){var e,u,o,i,a,f=function(){var c=zn()-u;r>c?e=setTimeout(f,r-c):(e=null,t||(i=n.apply(a,o)),e||(o=a=null))},c=j((function(c){return a=this,o=c,u=zn(),e||(e=setTimeout(f,r),t&&(i=n.apply(a,o))),i}));return c.cancel=function(){clearTimeout(e),e=o=a=null},c},wrap:function(n,r){return rr(r,n)},negate:fr,compose:function(){var n=arguments,r=n.length-1;return function(){for(var t=r,e=n[r].apply(this,arguments);t--;)e=n[t].call(this,e);return e}},after:function(n,r){return function(){if(--n<1)return r.apply(this,arguments)}},before:cr,once:lr,findKey:sr,findIndex:vr,findLastIndex:hr,sortedIndex:yr,indexOf:gr,lastIndexOf:br,find:mr,detect:mr,findWhere:function(n,r){return mr(n,Dn(r))},each:jr,forEach:jr,map:_r,collect:_r,reduce:Ar,foldl:Ar,inject:Ar,reduceRight:xr,foldr:xr,filter:Sr,select:Sr,reject:function(n,r,t){return Sr(n,fr(qn(r)),t)},every:Or,all:Or,some:Mr,any:Mr,contains:Er,includes:Er,include:Er,invoke:Br,pluck:Nr,where:function(n,r){return Sr(n,Dn(r))},max:Ir,min:function(n,r,t){var e,u,o=1/0,i=1/0;if(null==r||"number"==typeof r&&"object"!=typeof n[0]&&null!=n)for(var a=0,f=(n=er(n)?n:jn(n)).length;a<f;a++)null!=(e=n[a])&&e<o&&(o=e);else r=qn(r,t),jr(n,(function(n,t,e){((u=r(n,t,e))<i||u===1/0&&o===1/0)&&(o=n,i=u)}));return o},shuffle:function(n){return Tr(n,1/0)},sample:Tr,sortBy:function(n,r,t){var e=0;return r=qn(r,t),Nr(_r(n,(function(n,t,u){return{value:n,index:e++,criteria:r(n,t,u)}})).sort((function(n,r){var t=n.criteria,e=r.criteria;if(t!==e){if(t>e||void 0===t)return 1;if(t<e||void 0===e)return-1}return n.index-r.index})),"value")},groupBy:Dr,indexBy:Rr,countBy:Fr,partition:Vr,toArray:function(n){return n?U(n)?i.call(n):S(n)?n.match(Pr):er(n)?_r(n,kn):jn(n):[]},size:function(n){return null==n?0:er(n)?n.length:nn(n).length},pick:Ur,omit:Wr,first:Lr,head:Lr,take:Lr,initial:zr,last:function(n,r,t){return null==n||n.length<1?null==r||t?void 0:[]:null==r||t?n[n.length-1]:$r(n,Math.max(0,n.length-r))},rest:$r,tail:$r,drop:$r,compact:function(n){return Sr(n,Boolean)},flatten:function(n,r){return ur(n,r,!1)},without:Kr,uniq:Jr,unique:Jr,union:Gr,intersection:function(n){for(var r=[],t=arguments.length,e=0,u=Y(n);e<u;e++){var o=n[e];if(!Er(r,o)){var i;for(i=1;i<t&&Er(arguments[i],o);i++);i===t&&r.push(o)}}return r},difference:Cr,unzip:Hr,transpose:Hr,zip:Qr,object:function(n,r){for(var t={},e=0,u=Y(n);e<u;e++)r?t[n[e]]=r[e]:t[n[e][0]]=n[e][1];return t},range:function(n,r,t){null==r&&(r=n||0,n=0),t||(t=r<n?-1:1);for(var e=Math.max(Math.ceil((r-n)/t),0),u=Array(e),o=0;o<e;o++,n+=t)u[o]=n;return u},chunk:function(n,r){if(null==r||r<1)return[];for(var t=[],e=0,u=n.length;e<u;)t.push(i.call(n,e,e+=r));return t},mixin:Yr,default:tn});return Zr._=Zr,Zr}));


--------------------------------------------------------------------------------
/docs/_build/singlehtml/_static/up-pressed.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/devbisme/kinet2pcb/1ccad5d6df308126427aa7c3d0eafa693386e230/docs/_build/singlehtml/_static/up-pressed.png


--------------------------------------------------------------------------------
/docs/_build/singlehtml/_static/up.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/devbisme/kinet2pcb/1ccad5d6df308126427aa7c3d0eafa693386e230/docs/_build/singlehtml/_static/up.png


--------------------------------------------------------------------------------
/docs/_build/singlehtml/_static/websupport.js:
--------------------------------------------------------------------------------
  1 | /*
  2 |  * websupport.js
  3 |  * ~~~~~~~~~~~~~
  4 |  *
  5 |  * sphinx.websupport utilities for all documentation.
  6 |  *
  7 |  * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
  8 |  * :license: BSD, see LICENSE for details.
  9 |  *
 10 |  */
 11 | 
 12 | (function($) {
 13 |   $.fn.autogrow = function() {
 14 |     return this.each(function() {
 15 |     var textarea = this;
 16 | 
 17 |     $.fn.autogrow.resize(textarea);
 18 | 
 19 |     $(textarea)
 20 |       .focus(function() {
 21 |         textarea.interval = setInterval(function() {
 22 |           $.fn.autogrow.resize(textarea);
 23 |         }, 500);
 24 |       })
 25 |       .blur(function() {
 26 |         clearInterval(textarea.interval);
 27 |       });
 28 |     });
 29 |   };
 30 | 
 31 |   $.fn.autogrow.resize = function(textarea) {
 32 |     var lineHeight = parseInt($(textarea).css('line-height'), 10);
 33 |     var lines = textarea.value.split('\n');
 34 |     var columns = textarea.cols;
 35 |     var lineCount = 0;
 36 |     $.each(lines, function() {
 37 |       lineCount += Math.ceil(this.length / columns) || 1;
 38 |     });
 39 |     var height = lineHeight * (lineCount + 1);
 40 |     $(textarea).css('height', height);
 41 |   };
 42 | })(jQuery);
 43 | 
 44 | (function($) {
 45 |   var comp, by;
 46 | 
 47 |   function init() {
 48 |     initEvents();
 49 |     initComparator();
 50 |   }
 51 | 
 52 |   function initEvents() {
 53 |     $(document).on("click", 'a.comment-close', function(event) {
 54 |       event.preventDefault();
 55 |       hide($(this).attr('id').substring(2));
 56 |     });
 57 |     $(document).on("click", 'a.vote', function(event) {
 58 |       event.preventDefault();
 59 |       handleVote($(this));
 60 |     });
 61 |     $(document).on("click", 'a.reply', function(event) {
 62 |       event.preventDefault();
 63 |       openReply($(this).attr('id').substring(2));
 64 |     });
 65 |     $(document).on("click", 'a.close-reply', function(event) {
 66 |       event.preventDefault();
 67 |       closeReply($(this).attr('id').substring(2));
 68 |     });
 69 |     $(document).on("click", 'a.sort-option', function(event) {
 70 |       event.preventDefault();
 71 |       handleReSort($(this));
 72 |     });
 73 |     $(document).on("click", 'a.show-proposal', function(event) {
 74 |       event.preventDefault();
 75 |       showProposal($(this).attr('id').substring(2));
 76 |     });
 77 |     $(document).on("click", 'a.hide-proposal', function(event) {
 78 |       event.preventDefault();
 79 |       hideProposal($(this).attr('id').substring(2));
 80 |     });
 81 |     $(document).on("click", 'a.show-propose-change', function(event) {
 82 |       event.preventDefault();
 83 |       showProposeChange($(this).attr('id').substring(2));
 84 |     });
 85 |     $(document).on("click", 'a.hide-propose-change', function(event) {
 86 |       event.preventDefault();
 87 |       hideProposeChange($(this).attr('id').substring(2));
 88 |     });
 89 |     $(document).on("click", 'a.accept-comment', function(event) {
 90 |       event.preventDefault();
 91 |       acceptComment($(this).attr('id').substring(2));
 92 |     });
 93 |     $(document).on("click", 'a.delete-comment', function(event) {
 94 |       event.preventDefault();
 95 |       deleteComment($(this).attr('id').substring(2));
 96 |     });
 97 |     $(document).on("click", 'a.comment-markup', function(event) {
 98 |       event.preventDefault();
 99 |       toggleCommentMarkupBox($(this).attr('id').substring(2));
100 |     });
101 |   }
102 | 
103 |   /**
104 |    * Set comp, which is a comparator function used for sorting and
105 |    * inserting comments into the list.
106 |    */
107 |   function setComparator() {
108 |     // If the first three letters are "asc", sort in ascending order
109 |     // and remove the prefix.
110 |     if (by.substring(0,3) == 'asc') {
111 |       var i = by.substring(3);
112 |       comp = function(a, b) { return a[i] - b[i]; };
113 |     } else {
114 |       // Otherwise sort in descending order.
115 |       comp = function(a, b) { return b[by] - a[by]; };
116 |     }
117 | 
118 |     // Reset link styles and format the selected sort option.
119 |     $('a.sel').attr('href', '#').removeClass('sel');
120 |     $('a.by' + by).removeAttr('href').addClass('sel');
121 |   }
122 | 
123 |   /**
124 |    * Create a comp function. If the user has preferences stored in
125 |    * the sortBy cookie, use those, otherwise use the default.
126 |    */
127 |   function initComparator() {
128 |     by = 'rating'; // Default to sort by rating.
129 |     // If the sortBy cookie is set, use that instead.
130 |     if (document.cookie.length > 0) {
131 |       var start = document.cookie.indexOf('sortBy=');
132 |       if (start != -1) {
133 |         start = start + 7;
134 |         var end = document.cookie.indexOf(";", start);
135 |         if (end == -1) {
136 |           end = document.cookie.length;
137 |           by = unescape(document.cookie.substring(start, end));
138 |         }
139 |       }
140 |     }
141 |     setComparator();
142 |   }
143 | 
144 |   /**
145 |    * Show a comment div.
146 |    */
147 |   function show(id) {
148 |     $('#ao' + id).hide();
149 |     $('#ah' + id).show();
150 |     var context = $.extend({id: id}, opts);
151 |     var popup = $(renderTemplate(popupTemplate, context)).hide();
152 |     popup.find('textarea[name="proposal"]').hide();
153 |     popup.find('a.by' + by).addClass('sel');
154 |     var form = popup.find('#cf' + id);
155 |     form.submit(function(event) {
156 |       event.preventDefault();
157 |       addComment(form);
158 |     });
159 |     $('#s' + id).after(popup);
160 |     popup.slideDown('fast', function() {
161 |       getComments(id);
162 |     });
163 |   }
164 | 
165 |   /**
166 |    * Hide a comment div.
167 |    */
168 |   function hide(id) {
169 |     $('#ah' + id).hide();
170 |     $('#ao' + id).show();
171 |     var div = $('#sc' + id);
172 |     div.slideUp('fast', function() {
173 |       div.remove();
174 |     });
175 |   }
176 | 
177 |   /**
178 |    * Perform an ajax request to get comments for a node
179 |    * and insert the comments into the comments tree.
180 |    */
181 |   function getComments(id) {
182 |     $.ajax({
183 |      type: 'GET',
184 |      url: opts.getCommentsURL,
185 |      data: {node: id},
186 |      success: function(data, textStatus, request) {
187 |        var ul = $('#cl' + id);
188 |        var speed = 100;
189 |        $('#cf' + id)
190 |          .find('textarea[name="proposal"]')
191 |          .data('source', data.source);
192 | 
193 |        if (data.comments.length === 0) {
194 |          ul.html('<li>No comments yet.</li>');
195 |          ul.data('empty', true);
196 |        } else {
197 |          // If there are comments, sort them and put them in the list.
198 |          var comments = sortComments(data.comments);
199 |          speed = data.comments.length * 100;
200 |          appendComments(comments, ul);
201 |          ul.data('empty', false);
202 |        }
203 |        $('#cn' + id).slideUp(speed + 200);
204 |        ul.slideDown(speed);
205 |      },
206 |      error: function(request, textStatus, error) {
207 |        showError('Oops, there was a problem retrieving the comments.');
208 |      },
209 |      dataType: 'json'
210 |     });
211 |   }
212 | 
213 |   /**
214 |    * Add a comment via ajax and insert the comment into the comment tree.
215 |    */
216 |   function addComment(form) {
217 |     var node_id = form.find('input[name="node"]').val();
218 |     var parent_id = form.find('input[name="parent"]').val();
219 |     var text = form.find('textarea[name="comment"]').val();
220 |     var proposal = form.find('textarea[name="proposal"]').val();
221 | 
222 |     if (text == '') {
223 |       showError('Please enter a comment.');
224 |       return;
225 |     }
226 | 
227 |     // Disable the form that is being submitted.
228 |     form.find('textarea,input').attr('disabled', 'disabled');
229 | 
230 |     // Send the comment to the server.
231 |     $.ajax({
232 |       type: "POST",
233 |       url: opts.addCommentURL,
234 |       dataType: 'json',
235 |       data: {
236 |         node: node_id,
237 |         parent: parent_id,
238 |         text: text,
239 |         proposal: proposal
240 |       },
241 |       success: function(data, textStatus, error) {
242 |         // Reset the form.
243 |         if (node_id) {
244 |           hideProposeChange(node_id);
245 |         }
246 |         form.find('textarea')
247 |           .val('')
248 |           .add(form.find('input'))
249 |           .removeAttr('disabled');
250 | 	var ul = $('#cl' + (node_id || parent_id));
251 |         if (ul.data('empty')) {
252 |           $(ul).empty();
253 |           ul.data('empty', false);
254 |         }
255 |         insertComment(data.comment);
256 |         var ao = $('#ao' + node_id);
257 |         ao.find('img').attr({'src': opts.commentBrightImage});
258 |         if (node_id) {
259 |           // if this was a "root" comment, remove the commenting box
260 |           // (the user can get it back by reopening the comment popup)
261 |           $('#ca' + node_id).slideUp();
262 |         }
263 |       },
264 |       error: function(request, textStatus, error) {
265 |         form.find('textarea,input').removeAttr('disabled');
266 |         showError('Oops, there was a problem adding the comment.');
267 |       }
268 |     });
269 |   }
270 | 
271 |   /**
272 |    * Recursively append comments to the main comment list and children
273 |    * lists, creating the comment tree.
274 |    */
275 |   function appendComments(comments, ul) {
276 |     $.each(comments, function() {
277 |       var div = createCommentDiv(this);
278 |       ul.append($(document.createElement('li')).html(div));
279 |       appendComments(this.children, div.find('ul.comment-children'));
280 |       // To avoid stagnating data, don't store the comments children in data.
281 |       this.children = null;
282 |       div.data('comment', this);
283 |     });
284 |   }
285 | 
286 |   /**
287 |    * After adding a new comment, it must be inserted in the correct
288 |    * location in the comment tree.
289 |    */
290 |   function insertComment(comment) {
291 |     var div = createCommentDiv(comment);
292 | 
293 |     // To avoid stagnating data, don't store the comments children in data.
294 |     comment.children = null;
295 |     div.data('comment', comment);
296 | 
297 |     var ul = $('#cl' + (comment.node || comment.parent));
298 |     var siblings = getChildren(ul);
299 | 
300 |     var li = $(document.createElement('li'));
301 |     li.hide();
302 | 
303 |     // Determine where in the parents children list to insert this comment.
304 |     for(var i=0; i < siblings.length; i++) {
305 |       if (comp(comment, siblings[i]) <= 0) {
306 |         $('#cd' + siblings[i].id)
307 |           .parent()
308 |           .before(li.html(div));
309 |         li.slideDown('fast');
310 |         return;
311 |       }
312 |     }
313 | 
314 |     // If we get here, this comment rates lower than all the others,
315 |     // or it is the only comment in the list.
316 |     ul.append(li.html(div));
317 |     li.slideDown('fast');
318 |   }
319 | 
320 |   function acceptComment(id) {
321 |     $.ajax({
322 |       type: 'POST',
323 |       url: opts.acceptCommentURL,
324 |       data: {id: id},
325 |       success: function(data, textStatus, request) {
326 |         $('#cm' + id).fadeOut('fast');
327 |         $('#cd' + id).removeClass('moderate');
328 |       },
329 |       error: function(request, textStatus, error) {
330 |         showError('Oops, there was a problem accepting the comment.');
331 |       }
332 |     });
333 |   }
334 | 
335 |   function deleteComment(id) {
336 |     $.ajax({
337 |       type: 'POST',
338 |       url: opts.deleteCommentURL,
339 |       data: {id: id},
340 |       success: function(data, textStatus, request) {
341 |         var div = $('#cd' + id);
342 |         if (data == 'delete') {
343 |           // Moderator mode: remove the comment and all children immediately
344 |           div.slideUp('fast', function() {
345 |             div.remove();
346 |           });
347 |           return;
348 |         }
349 |         // User mode: only mark the comment as deleted
350 |         div
351 |           .find('span.user-id:first')
352 |           .text('[deleted]').end()
353 |           .find('div.comment-text:first')
354 |           .text('[deleted]').end()
355 |           .find('#cm' + id + ', #dc' + id + ', #ac' + id + ', #rc' + id +
356 |                 ', #sp' + id + ', #hp' + id + ', #cr' + id + ', #rl' + id)
357 |           .remove();
358 |         var comment = div.data('comment');
359 |         comment.username = '[deleted]';
360 |         comment.text = '[deleted]';
361 |         div.data('comment', comment);
362 |       },
363 |       error: function(request, textStatus, error) {
364 |         showError('Oops, there was a problem deleting the comment.');
365 |       }
366 |     });
367 |   }
368 | 
369 |   function showProposal(id) {
370 |     $('#sp' + id).hide();
371 |     $('#hp' + id).show();
372 |     $('#pr' + id).slideDown('fast');
373 |   }
374 | 
375 |   function hideProposal(id) {
376 |     $('#hp' + id).hide();
377 |     $('#sp' + id).show();
378 |     $('#pr' + id).slideUp('fast');
379 |   }
380 | 
381 |   function showProposeChange(id) {
382 |     $('#pc' + id).hide();
383 |     $('#hc' + id).show();
384 |     var textarea = $('#pt' + id);
385 |     textarea.val(textarea.data('source'));
386 |     $.fn.autogrow.resize(textarea[0]);
387 |     textarea.slideDown('fast');
388 |   }
389 | 
390 |   function hideProposeChange(id) {
391 |     $('#hc' + id).hide();
392 |     $('#pc' + id).show();
393 |     var textarea = $('#pt' + id);
394 |     textarea.val('').removeAttr('disabled');
395 |     textarea.slideUp('fast');
396 |   }
397 | 
398 |   function toggleCommentMarkupBox(id) {
399 |     $('#mb' + id).toggle();
400 |   }
401 | 
402 |   /** Handle when the user clicks on a sort by link. */
403 |   function handleReSort(link) {
404 |     var classes = link.attr('class').split(/\s+/);
405 |     for (var i=0; i<classes.length; i++) {
406 |       if (classes[i] != 'sort-option') {
407 | 	by = classes[i].substring(2);
408 |       }
409 |     }
410 |     setComparator();
411 |     // Save/update the sortBy cookie.
412 |     var expiration = new Date();
413 |     expiration.setDate(expiration.getDate() + 365);
414 |     document.cookie= 'sortBy=' + escape(by) +
415 |                      ';expires=' + expiration.toUTCString();
416 |     $('ul.comment-ul').each(function(index, ul) {
417 |       var comments = getChildren($(ul), true);
418 |       comments = sortComments(comments);
419 |       appendComments(comments, $(ul).empty());
420 |     });
421 |   }
422 | 
423 |   /**
424 |    * Function to process a vote when a user clicks an arrow.
425 |    */
426 |   function handleVote(link) {
427 |     if (!opts.voting) {
428 |       showError("You'll need to login to vote.");
429 |       return;
430 |     }
431 | 
432 |     var id = link.attr('id');
433 |     if (!id) {
434 |       // Didn't click on one of the voting arrows.
435 |       return;
436 |     }
437 |     // If it is an unvote, the new vote value is 0,
438 |     // Otherwise it's 1 for an upvote, or -1 for a downvote.
439 |     var value = 0;
440 |     if (id.charAt(1) != 'u') {
441 |       value = id.charAt(0) == 'u' ? 1 : -1;
442 |     }
443 |     // The data to be sent to the server.
444 |     var d = {
445 |       comment_id: id.substring(2),
446 |       value: value
447 |     };
448 | 
449 |     // Swap the vote and unvote links.
450 |     link.hide();
451 |     $('#' + id.charAt(0) + (id.charAt(1) == 'u' ? 'v' : 'u') + d.comment_id)
452 |       .show();
453 | 
454 |     // The div the comment is displayed in.
455 |     var div = $('div#cd' + d.comment_id);
456 |     var data = div.data('comment');
457 | 
458 |     // If this is not an unvote, and the other vote arrow has
459 |     // already been pressed, unpress it.
460 |     if ((d.value !== 0) && (data.vote === d.value * -1)) {
461 |       $('#' + (d.value == 1 ? 'd' : 'u') + 'u' + d.comment_id).hide();
462 |       $('#' + (d.value == 1 ? 'd' : 'u') + 'v' + d.comment_id).show();
463 |     }
464 | 
465 |     // Update the comments rating in the local data.
466 |     data.rating += (data.vote === 0) ? d.value : (d.value - data.vote);
467 |     data.vote = d.value;
468 |     div.data('comment', data);
469 | 
470 |     // Change the rating text.
471 |     div.find('.rating:first')
472 |       .text(data.rating + ' point' + (data.rating == 1 ? '' : 's'));
473 | 
474 |     // Send the vote information to the server.
475 |     $.ajax({
476 |       type: "POST",
477 |       url: opts.processVoteURL,
478 |       data: d,
479 |       error: function(request, textStatus, error) {
480 |         showError('Oops, there was a problem casting that vote.');
481 |       }
482 |     });
483 |   }
484 | 
485 |   /**
486 |    * Open a reply form used to reply to an existing comment.
487 |    */
488 |   function openReply(id) {
489 |     // Swap out the reply link for the hide link
490 |     $('#rl' + id).hide();
491 |     $('#cr' + id).show();
492 | 
493 |     // Add the reply li to the children ul.
494 |     var div = $(renderTemplate(replyTemplate, {id: id})).hide();
495 |     $('#cl' + id)
496 |       .prepend(div)
497 |       // Setup the submit handler for the reply form.
498 |       .find('#rf' + id)
499 |       .submit(function(event) {
500 |         event.preventDefault();
501 |         addComment($('#rf' + id));
502 |         closeReply(id);
503 |       })
504 |       .find('input[type=button]')
505 |       .click(function() {
506 |         closeReply(id);
507 |       });
508 |     div.slideDown('fast', function() {
509 |       $('#rf' + id).find('textarea').focus();
510 |     });
511 |   }
512 | 
513 |   /**
514 |    * Close the reply form opened with openReply.
515 |    */
516 |   function closeReply(id) {
517 |     // Remove the reply div from the DOM.
518 |     $('#rd' + id).slideUp('fast', function() {
519 |       $(this).remove();
520 |     });
521 | 
522 |     // Swap out the hide link for the reply link
523 |     $('#cr' + id).hide();
524 |     $('#rl' + id).show();
525 |   }
526 | 
527 |   /**
528 |    * Recursively sort a tree of comments using the comp comparator.
529 |    */
530 |   function sortComments(comments) {
531 |     comments.sort(comp);
532 |     $.each(comments, function() {
533 |       this.children = sortComments(this.children);
534 |     });
535 |     return comments;
536 |   }
537 | 
538 |   /**
539 |    * Get the children comments from a ul. If recursive is true,
540 |    * recursively include childrens' children.
541 |    */
542 |   function getChildren(ul, recursive) {
543 |     var children = [];
544 |     ul.children().children("[id^='cd']")
545 |       .each(function() {
546 |         var comment = $(this).data('comment');
547 |         if (recursive)
548 |           comment.children = getChildren($(this).find('#cl' + comment.id), true);
549 |         children.push(comment);
550 |       });
551 |     return children;
552 |   }
553 | 
554 |   /** Create a div to display a comment in. */
555 |   function createCommentDiv(comment) {
556 |     if (!comment.displayed && !opts.moderator) {
557 |       return $('<div class="moderate">Thank you!  Your comment will show up '
558 |                + 'once it is has been approved by a moderator.</div>');
559 |     }
560 |     // Prettify the comment rating.
561 |     comment.pretty_rating = comment.rating + ' point' +
562 |       (comment.rating == 1 ? '' : 's');
563 |     // Make a class (for displaying not yet moderated comments differently)
564 |     comment.css_class = comment.displayed ? '' : ' moderate';
565 |     // Create a div for this comment.
566 |     var context = $.extend({}, opts, comment);
567 |     var div = $(renderTemplate(commentTemplate, context));
568 | 
569 |     // If the user has voted on this comment, highlight the correct arrow.
570 |     if (comment.vote) {
571 |       var direction = (comment.vote == 1) ? 'u' : 'd';
572 |       div.find('#' + direction + 'v' + comment.id).hide();
573 |       div.find('#' + direction + 'u' + comment.id).show();
574 |     }
575 | 
576 |     if (opts.moderator || comment.text != '[deleted]') {
577 |       div.find('a.reply').show();
578 |       if (comment.proposal_diff)
579 |         div.find('#sp' + comment.id).show();
580 |       if (opts.moderator && !comment.displayed)
581 |         div.find('#cm' + comment.id).show();
582 |       if (opts.moderator || (opts.username == comment.username))
583 |         div.find('#dc' + comment.id).show();
584 |     }
585 |     return div;
586 |   }
587 | 
588 |   /**
589 |    * A simple template renderer. Placeholders such as <%id%> are replaced
590 |    * by context['id'] with items being escaped. Placeholders such as <#id#>
591 |    * are not escaped.
592 |    */
593 |   function renderTemplate(template, context) {
594 |     var esc = $(document.createElement('div'));
595 | 
596 |     function handle(ph, escape) {
597 |       var cur = context;
598 |       $.each(ph.split('.'), function() {
599 |         cur = cur[this];
600 |       });
601 |       return escape ? esc.text(cur || "").html() : cur;
602 |     }
603 | 
604 |     return template.replace(/<([%#])([\w\.]*)\1>/g, function() {
605 |       return handle(arguments[2], arguments[1] == '%' ? true : false);
606 |     });
607 |   }
608 | 
609 |   /** Flash an error message briefly. */
610 |   function showError(message) {
611 |     $(document.createElement('div')).attr({'class': 'popup-error'})
612 |       .append($(document.createElement('div'))
613 |                .attr({'class': 'error-message'}).text(message))
614 |       .appendTo('body')
615 |       .fadeIn("slow")
616 |       .delay(2000)
617 |       .fadeOut("slow");
618 |   }
619 | 
620 |   /** Add a link the user uses to open the comments popup. */
621 |   $.fn.comment = function() {
622 |     return this.each(function() {
623 |       var id = $(this).attr('id').substring(1);
624 |       var count = COMMENT_METADATA[id];
625 |       var title = count + ' comment' + (count == 1 ? '' : 's');
626 |       var image = count > 0 ? opts.commentBrightImage : opts.commentImage;
627 |       var addcls = count == 0 ? ' nocomment' : '';
628 |       $(this)
629 |         .append(
630 |           $(document.createElement('a')).attr({
631 |             href: '#',
632 |             'class': 'sphinx-comment-open' + addcls,
633 |             id: 'ao' + id
634 |           })
635 |             .append($(document.createElement('img')).attr({
636 |               src: image,
637 |               alt: 'comment',
638 |               title: title
639 |             }))
640 |             .click(function(event) {
641 |               event.preventDefault();
642 |               show($(this).attr('id').substring(2));
643 |             })
644 |         )
645 |         .append(
646 |           $(document.createElement('a')).attr({
647 |             href: '#',
648 |             'class': 'sphinx-comment-close hidden',
649 |             id: 'ah' + id
650 |           })
651 |             .append($(document.createElement('img')).attr({
652 |               src: opts.closeCommentImage,
653 |               alt: 'close',
654 |               title: 'close'
655 |             }))
656 |             .click(function(event) {
657 |               event.preventDefault();
658 |               hide($(this).attr('id').substring(2));
659 |             })
660 |         );
661 |     });
662 |   };
663 | 
664 |   var opts = {
665 |     processVoteURL: '/_process_vote',
666 |     addCommentURL: '/_add_comment',
667 |     getCommentsURL: '/_get_comments',
668 |     acceptCommentURL: '/_accept_comment',
669 |     deleteCommentURL: '/_delete_comment',
670 |     commentImage: '/static/_static/comment.png',
671 |     closeCommentImage: '/static/_static/comment-close.png',
672 |     loadingImage: '/static/_static/ajax-loader.gif',
673 |     commentBrightImage: '/static/_static/comment-bright.png',
674 |     upArrow: '/static/_static/up.png',
675 |     downArrow: '/static/_static/down.png',
676 |     upArrowPressed: '/static/_static/up-pressed.png',
677 |     downArrowPressed: '/static/_static/down-pressed.png',
678 |     voting: false,
679 |     moderator: false
680 |   };
681 | 
682 |   if (typeof COMMENT_OPTIONS != "undefined") {
683 |     opts = jQuery.extend(opts, COMMENT_OPTIONS);
684 |   }
685 | 
686 |   var popupTemplate = '\
687 |     <div class="sphinx-comments" id="sc<%id%>">\
688 |       <p class="sort-options">\
689 |         Sort by:\
690 |         <a href="#" class="sort-option byrating">best rated</a>\
691 |         <a href="#" class="sort-option byascage">newest</a>\
692 |         <a href="#" class="sort-option byage">oldest</a>\
693 |       </p>\
694 |       <div class="comment-header">Comments</div>\
695 |       <div class="comment-loading" id="cn<%id%>">\
696 |         loading comments... <img src="<%loadingImage%>" alt="" /></div>\
697 |       <ul id="cl<%id%>" class="comment-ul"></ul>\
698 |       <div id="ca<%id%>">\
699 |       <p class="add-a-comment">Add a comment\
700 |         (<a href="#" class="comment-markup" id="ab<%id%>">markup</a>):</p>\
701 |       <div class="comment-markup-box" id="mb<%id%>">\
702 |         reStructured text markup: <i>*emph*</i>, <b>**strong**</b>, \
703 |         <code>``code``</code>, \
704 |         code blocks: <code>::</code> and an indented block after blank line</div>\
705 |       <form method="post" id="cf<%id%>" class="comment-form" action="">\
706 |         <textarea name="comment" cols="80"></textarea>\
707 |         <p class="propose-button">\
708 |           <a href="#" id="pc<%id%>" class="show-propose-change">\
709 |             Propose a change &#9657;\
710 |           </a>\
711 |           <a href="#" id="hc<%id%>" class="hide-propose-change">\
712 |             Propose a change &#9663;\
713 |           </a>\
714 |         </p>\
715 |         <textarea name="proposal" id="pt<%id%>" cols="80"\
716 |                   spellcheck="false"></textarea>\
717 |         <input type="submit" value="Add comment" />\
718 |         <input type="hidden" name="node" value="<%id%>" />\
719 |         <input type="hidden" name="parent" value="" />\
720 |       </form>\
721 |       </div>\
722 |     </div>';
723 | 
724 |   var commentTemplate = '\
725 |     <div id="cd<%id%>" class="sphinx-comment<%css_class%>">\
726 |       <div class="vote">\
727 |         <div class="arrow">\
728 |           <a href="#" id="uv<%id%>" class="vote" title="vote up">\
729 |             <img src="<%upArrow%>" />\
730 |           </a>\
731 |           <a href="#" id="uu<%id%>" class="un vote" title="vote up">\
732 |             <img src="<%upArrowPressed%>" />\
733 |           </a>\
734 |         </div>\
735 |         <div class="arrow">\
736 |           <a href="#" id="dv<%id%>" class="vote" title="vote down">\
737 |             <img src="<%downArrow%>" id="da<%id%>" />\
738 |           </a>\
739 |           <a href="#" id="du<%id%>" class="un vote" title="vote down">\
740 |             <img src="<%downArrowPressed%>" />\
741 |           </a>\
742 |         </div>\
743 |       </div>\
744 |       <div class="comment-content">\
745 |         <p class="tagline comment">\
746 |           <span class="user-id"><%username%></span>\
747 |           <span class="rating"><%pretty_rating%></span>\
748 |           <span class="delta"><%time.delta%></span>\
749 |         </p>\
750 |         <div class="comment-text comment"><#text#></div>\
751 |         <p class="comment-opts comment">\
752 |           <a href="#" class="reply hidden" id="rl<%id%>">reply &#9657;</a>\
753 |           <a href="#" class="close-reply" id="cr<%id%>">reply &#9663;</a>\
754 |           <a href="#" id="sp<%id%>" class="show-proposal">proposal &#9657;</a>\
755 |           <a href="#" id="hp<%id%>" class="hide-proposal">proposal &#9663;</a>\
756 |           <a href="#" id="dc<%id%>" class="delete-comment hidden">delete</a>\
757 |           <span id="cm<%id%>" class="moderation hidden">\
758 |             <a href="#" id="ac<%id%>" class="accept-comment">accept</a>\
759 |           </span>\
760 |         </p>\
761 |         <pre class="proposal" id="pr<%id%>">\
762 | <#proposal_diff#>\
763 |         </pre>\
764 |           <ul class="comment-children" id="cl<%id%>"></ul>\
765 |         </div>\
766 |         <div class="clearleft"></div>\
767 |       </div>\
768 |     </div>';
769 | 
770 |   var replyTemplate = '\
771 |     <li>\
772 |       <div class="reply-div" id="rd<%id%>">\
773 |         <form id="rf<%id%>">\
774 |           <textarea name="comment" cols="80"></textarea>\
775 |           <input type="submit" value="Add reply" />\
776 |           <input type="button" value="Cancel" />\
777 |           <input type="hidden" name="parent" value="<%id%>" />\
778 |           <input type="hidden" name="node" value="" />\
779 |         </form>\
780 |       </div>\
781 |     </li>';
782 | 
783 |   $(document).ready(function() {
784 |     init();
785 |   });
786 | })(jQuery);
787 | 
788 | $(document).ready(function() {
789 |   // add comment anchors for all paragraphs that are commentable
790 |   $('.sphinx-has-comment').comment();
791 | 
792 |   // highlight search words in search results
793 |   $("div.context").each(function() {
794 |     var params = $.getQueryParameters();
795 |     var terms = (params.q) ? params.q[0].split(/\s+/) : [];
796 |     var result = $(this);
797 |     $.each(terms, function() {
798 |       result.highlightText(this.toLowerCase(), 'highlighted');
799 |     });
800 |   });
801 | 
802 |   // directly open comment window if requested
803 |   var anchor = document.location.hash;
804 |   if (anchor.substring(0, 9) == '#comment-') {
805 |     $('#ao' + anchor.substring(9)).click();
806 |     document.location.hash = '#s' + anchor.substring(9);
807 |   }
808 | });
809 | 


--------------------------------------------------------------------------------
/docs/_build/singlehtml/index.html:
--------------------------------------------------------------------------------
  1 | 
  2 | <!DOCTYPE html>
  3 | 
  4 | <html lang="en">
  5 |   <head>
  6 |     <meta charset="utf-8" />
  7 |     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
  8 | 
  9 |     <title>kinet2pcb 1.1.2 documentation</title>
 10 |     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
 11 |     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
 12 |     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
 13 |     <script src="_static/jquery.js"></script>
 14 |     <script src="_static/underscore.js"></script>
 15 |     <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
 16 |     <script src="_static/doctools.js"></script>
 17 |     <link rel="index" title="Index" href="genindex.html" />
 18 |     <link rel="search" title="Search" href="search.html" />
 19 |    
 20 |   <link rel="stylesheet" href="_static/custom.css" type="text/css" />
 21 |   
 22 |   
 23 |   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
 24 | 
 25 |   </head><body>
 26 |   
 27 | 
 28 |     <div class="document">
 29 |       <div class="documentwrapper">
 30 |         <div class="bodywrapper">
 31 |           
 32 | 
 33 |           <div class="body" role="main">
 34 |             
 35 |   <section id="welcome-to-kinet2pcb-s-documentation">
 36 | <h1>Welcome to kinet2pcb’s documentation!<a class="headerlink" href="#welcome-to-kinet2pcb-s-documentation" title="Permalink to this heading">¶</a></h1>
 37 | <div class="toctree-wrapper compound">
 38 | <span id="document-readme"></span><section id="kinet2pcb">
 39 | <h2>kinet2pcb<a class="headerlink" href="#kinet2pcb" title="Permalink to this heading">¶</a></h2>
 40 | <a class="reference external image-reference" href="https://pypi.python.org/pypi/kinet2pcb"><img alt="https://img.shields.io/pypi/v/kinet2pcb.svg" src="https://img.shields.io/pypi/v/kinet2pcb.svg" /></a>
 41 | <p>Convert KiCad netlist into a PCBNEW <code class="docutils literal notranslate"><span class="pre">.kicad_pcb</span></code> file.</p>
 42 | <ul class="simple">
 43 | <li><p>Free software: MIT license</p></li>
 44 | <li><p>Documentation: <a class="reference external" href="https://devbisme.github.io/kinet2pcb">https://devbisme.github.io/kinet2pcb</a> .</p></li>
 45 | </ul>
 46 | <section id="features">
 47 | <h3>Features<a class="headerlink" href="#features" title="Permalink to this heading">¶</a></h3>
 48 | <ul class="simple">
 49 | <li><p>Converts a KiCad netlist file into a <code class="docutils literal notranslate"><span class="pre">.kicad_pcb</span></code> file that can be edited with PCBNEW.</p></li>
 50 | </ul>
 51 | </section>
 52 | <section id="credits">
 53 | <h3>Credits<a class="headerlink" href="#credits" title="Permalink to this heading">¶</a></h3>
 54 | <p>This package was created with <a class="reference external" href="https://github.com/audreyr/cookiecutter">Cookiecutter</a> and the <a class="reference external" href="https://github.com/audreyr/cookiecutter-pypackage">audreyr/cookiecutter-pypackage</a> project template.</p>
 55 | </section>
 56 | </section>
 57 | <span id="document-installation"></span><section id="installation">
 58 | <h2>Installation<a class="headerlink" href="#installation" title="Permalink to this heading">¶</a></h2>
 59 | <p>This is a Python package, and it requires the <code class="docutils literal notranslate"><span class="pre">pcbnew</span></code> module included with KiCad.
 60 | Therefore, you’ll have to install it using the <code class="docutils literal notranslate"><span class="pre">pip</span></code> executable included in the
 61 | KiCad <code class="docutils literal notranslate"><span class="pre">bin</span></code> directory like so:</p>
 62 | <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>pip<span class="w"> </span>install<span class="w"> </span>kinet2pcb
 63 | </pre></div>
 64 | </div>
 65 | <p>This is the preferred method to install <code class="docutils literal notranslate"><span class="pre">kinet2pcb</span></code>, as it will always install the most recent stable release.</p>
 66 | <p>You can also install <code class="docutils literal notranslate"><span class="pre">kinet2pcb</span></code> in the Python interpreter on your system using its <code class="docutils literal notranslate"><span class="pre">pip</span></code> command,
 67 | but your system libraries probably won’t include the <code class="docutils literal notranslate"><span class="pre">pcbnew</span></code> module.
 68 | By default, <code class="docutils literal notranslate"><span class="pre">kinet2pcb</span></code> adds <code class="docutils literal notranslate"><span class="pre">/usr/lib/python3/dist-packages</span></code> to the Python library
 69 | search path which is where KiCad normally stores <code class="docutils literal notranslate"><span class="pre">pcbnew</span></code> in a linux system.
 70 | If your system doesn’t follow this convention, then you’ll have to search for
 71 | the <code class="docutils literal notranslate"><span class="pre">pcbnew.py</span></code> file and add its path to the <code class="docutils literal notranslate"><span class="pre">PYTHONPATH</span></code> environment variable.</p>
 72 | </section>
 73 | <span id="document-usage"></span><section id="usage">
 74 | <h2>Usage<a class="headerlink" href="#usage" title="Permalink to this heading">¶</a></h2>
 75 | <p><code class="docutils literal notranslate"><span class="pre">kinet2pcb</span></code> can be used as a module to provide other scripts with the ability
 76 | to create KiCad PCB files, but it is mainly intended to serve as its own stand-alone utility:</p>
 77 | <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">kinet2pcb</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">version</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="nb">input</span> <span class="n">file</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">output</span> <span class="p">[</span><span class="n">file</span><span class="p">]]</span> <span class="p">[</span><span class="o">--</span><span class="n">overwrite</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">nobackup</span><span class="p">]</span>
 78 |                 <span class="p">[</span><span class="o">--</span><span class="n">libraries</span> <span class="n">footprint_dir</span> <span class="p">[</span><span class="n">footprint_dir</span> <span class="o">...</span><span class="p">]]</span> <span class="p">[</span><span class="o">--</span><span class="n">debug</span> <span class="p">[</span><span class="n">LEVEL</span><span class="p">]]</span>
 79 | 
 80 | <span class="n">Convert</span> <span class="n">KiCad</span> <span class="n">netlist</span> <span class="n">into</span> <span class="n">a</span> <span class="n">PCBNEW</span> <span class="o">.</span><span class="n">kicad_pcb</span> <span class="n">file</span><span class="o">.</span>
 81 | 
 82 | <span class="n">optional</span> <span class="n">arguments</span><span class="p">:</span>
 83 | <span class="o">-</span><span class="n">h</span><span class="p">,</span> <span class="o">--</span><span class="n">help</span>            <span class="n">show</span> <span class="n">this</span> <span class="n">help</span> <span class="n">message</span> <span class="ow">and</span> <span class="n">exit</span>
 84 | <span class="o">--</span><span class="n">version</span><span class="p">,</span> <span class="o">-</span><span class="n">v</span>         <span class="n">show</span> <span class="n">program</span><span class="s1">&#39;s version number and exit</span>
 85 | <span class="o">--</span><span class="nb">input</span> <span class="n">file</span><span class="p">,</span> <span class="o">-</span><span class="n">i</span> <span class="n">file</span>
 86 |                         <span class="n">Input</span> <span class="n">file</span> <span class="n">containing</span> <span class="n">KiCad</span> <span class="n">netlist</span><span class="o">.</span>
 87 | <span class="o">--</span><span class="n">output</span> <span class="p">[</span><span class="n">file</span><span class="p">],</span> <span class="o">-</span><span class="n">o</span> <span class="p">[</span><span class="n">file</span><span class="p">]</span>
 88 |                         <span class="n">Output</span> <span class="n">file</span> <span class="k">for</span> <span class="n">storing</span> <span class="n">KiCad</span> <span class="n">board</span><span class="o">.</span>
 89 | <span class="o">--</span><span class="n">overwrite</span><span class="p">,</span> <span class="o">-</span><span class="n">w</span>       <span class="n">Allow</span> <span class="n">overwriting</span> <span class="n">of</span> <span class="n">an</span> <span class="n">existing</span> <span class="n">board</span> <span class="n">file</span><span class="o">.</span>
 90 | <span class="o">--</span><span class="n">nobackup</span><span class="p">,</span> <span class="o">-</span><span class="n">nb</span>       <span class="n">Do</span> <span class="o">*</span><span class="ow">not</span><span class="o">*</span> <span class="n">create</span> <span class="n">backups</span> <span class="n">before</span> <span class="n">modifying</span> <span class="n">files</span><span class="o">.</span> <span class="p">(</span><span class="n">Default</span> <span class="ow">is</span> <span class="n">to</span> <span class="n">make</span> <span class="n">backup</span> <span class="n">files</span><span class="o">.</span><span class="p">)</span>
 91 | <span class="o">--</span><span class="n">libraries</span> <span class="n">footprint_dir</span> <span class="p">[</span><span class="n">footprint_dir</span> <span class="o">...</span><span class="p">],</span> <span class="o">-</span><span class="n">l</span> <span class="n">footprint_dir</span> <span class="p">[</span><span class="n">footprint_dir</span> <span class="o">...</span><span class="p">]</span>
 92 |                         <span class="n">Specify</span> <span class="n">one</span> <span class="ow">or</span> <span class="n">more</span> <span class="n">directories</span> <span class="n">containing</span> <span class="o">.</span><span class="n">pretty</span> <span class="n">footprint</span> <span class="n">libraries</span><span class="o">.</span>
 93 | <span class="o">--</span><span class="n">debug</span> <span class="p">[</span><span class="n">LEVEL</span><span class="p">],</span> <span class="o">-</span><span class="n">d</span> <span class="p">[</span><span class="n">LEVEL</span><span class="p">]</span>
 94 |                         <span class="n">Print</span> <span class="n">debugging</span> <span class="n">info</span><span class="o">.</span> <span class="p">(</span><span class="n">Larger</span> <span class="n">LEVEL</span> <span class="n">means</span> <span class="n">more</span> <span class="n">info</span><span class="o">.</span><span class="p">)</span>
 95 | </pre></div>
 96 | </div>
 97 | <section id="examples">
 98 | <h3>Examples<a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h3>
 99 | <p>Assuming you’ve generated a KiCad netlist file called <code class="docutils literal notranslate"><span class="pre">example.net</span></code>, then
100 | the following command would create a KiCad PCB file called <code class="docutils literal notranslate"><span class="pre">example.kicad_pcb</span></code>:</p>
101 | <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">kinet2pcb</span> <span class="o">-</span><span class="n">i</span> <span class="n">example</span><span class="o">.</span><span class="n">net</span>
102 | </pre></div>
103 | </div>
104 | <p>If a files called <code class="docutils literal notranslate"><span class="pre">example.kicad_pcb</span></code> already exists, then <code class="docutils literal notranslate"><span class="pre">kinet2pcb</span></code> will
105 | halt and not over-write the file. To override this behavior, use the <code class="docutils literal notranslate"><span class="pre">-w</span></code> option:</p>
106 | <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">kinet2pcb</span> <span class="o">-</span><span class="n">i</span> <span class="n">example</span><span class="o">.</span><span class="n">net</span> <span class="o">-</span><span class="n">w</span>
107 | </pre></div>
108 | </div>
109 | <p>The above command will rename the pre-existing <code class="docutils literal notranslate"><span class="pre">example.kicad_pcb</span></code> file to
110 | <code class="docutils literal notranslate"><span class="pre">example.kicad_pcb.bak</span></code>.</p>
111 | <p>If you have one or more libraries of part footprints that are not listed in your
112 | KiCad <code class="docutils literal notranslate"><span class="pre">fp-lib-tables</span></code> file, you can specify them on the command line like so:</p>
113 | <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">kinet2pcb</span> <span class="o">-</span><span class="n">i</span> <span class="n">example</span><span class="o">.</span><span class="n">net</span> <span class="o">--</span><span class="n">libraries</span> <span class="o">/</span><span class="n">my</span><span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">lib_1</span><span class="o">.</span><span class="n">pretty</span> <span class="o">/</span><span class="n">my</span><span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">lib2</span><span class="o">.</span><span class="n">pretty</span>
114 | </pre></div>
115 | </div>
116 | <p>If you have a lot of libraries that are all stored in a single directory, then
117 | you can shorten the command by just listing the parent directory:</p>
118 | <blockquote>
119 | <div><p>kinet2pcb -i example.net –libraries /my/path/to</p>
120 | </div></blockquote>
121 | </section>
122 | <section id="preventing-disasters">
123 | <h3>Preventing Disasters<a class="headerlink" href="#preventing-disasters" title="Permalink to this heading">¶</a></h3>
124 | <p>A lot of work goes into creating a PCB.
125 | For this reason, <code class="docutils literal notranslate"><span class="pre">kinet2pcb</span></code> makes a backup of any <code class="docutils literal notranslate"><span class="pre">.kicad_pcb</span></code> file it is about to overwrite
126 | (using file names such as <code class="docutils literal notranslate"><span class="pre">example.1.kicad_pcb</span></code>, <code class="docutils literal notranslate"><span class="pre">example.2.kicad_pcb</span></code>, etc.).
127 | You can turn off this behavior using the <code class="docutils literal notranslate"><span class="pre">--nobackup</span></code> option.</p>
128 | <p>In addition, if <code class="docutils literal notranslate"><span class="pre">kinet2pcb</span></code> would overwrite an existing <code class="docutils literal notranslate"><span class="pre">.kicad_pcb</span></code> file
129 | and the <code class="docutils literal notranslate"><span class="pre">--nobackup</span></code> option is enabled, then you must also use the <code class="docutils literal notranslate"><span class="pre">--overwrite</span></code> option
130 | or the operation will be aborted.</p>
131 | </section>
132 | </section>
133 | <span id="document-contributing"></span><section id="contributing">
134 | <h2>Contributing<a class="headerlink" href="#contributing" title="Permalink to this heading">¶</a></h2>
135 | <p>Contributions are welcome, and they are greatly appreciated! Every little bit
136 | helps, and credit will always be given.</p>
137 | <p>You can contribute in many ways:</p>
138 | <section id="types-of-contributions">
139 | <h3>Types of Contributions<a class="headerlink" href="#types-of-contributions" title="Permalink to this heading">¶</a></h3>
140 | <section id="report-bugs">
141 | <h4>Report Bugs<a class="headerlink" href="#report-bugs" title="Permalink to this heading">¶</a></h4>
142 | <p>Report bugs at <a class="reference external" href="https://github.com/devbisme/kinet2pcb/issues">https://github.com/devbisme/kinet2pcb/issues</a>.</p>
143 | <p>If you are reporting a bug, please include:</p>
144 | <ul class="simple">
145 | <li><p>Your operating system name and version.</p></li>
146 | <li><p>Any details about your local setup that might be helpful in troubleshooting.</p></li>
147 | <li><p>Detailed steps to reproduce the bug.</p></li>
148 | </ul>
149 | </section>
150 | <section id="fix-bugs">
151 | <h4>Fix Bugs<a class="headerlink" href="#fix-bugs" title="Permalink to this heading">¶</a></h4>
152 | <p>Look through the GitHub issues for bugs. Anything tagged with “bug” and “help
153 | wanted” is open to whoever wants to implement it.</p>
154 | </section>
155 | <section id="implement-features">
156 | <h4>Implement Features<a class="headerlink" href="#implement-features" title="Permalink to this heading">¶</a></h4>
157 | <p>Look through the GitHub issues for features. Anything tagged with “enhancement”
158 | and “help wanted” is open to whoever wants to implement it.</p>
159 | </section>
160 | <section id="write-documentation">
161 | <h4>Write Documentation<a class="headerlink" href="#write-documentation" title="Permalink to this heading">¶</a></h4>
162 | <p>kinet2pcb could always use more documentation, whether as part of the
163 | official kinet2pcb docs, in docstrings, or even on the web in blog posts,
164 | articles, and such.</p>
165 | </section>
166 | <section id="submit-feedback">
167 | <h4>Submit Feedback<a class="headerlink" href="#submit-feedback" title="Permalink to this heading">¶</a></h4>
168 | <p>The best way to send feedback is to file an issue at <a class="reference external" href="https://github.com/devbisme/kinet2pcb/issues">https://github.com/devbisme/kinet2pcb/issues</a>.</p>
169 | <p>If you are proposing a feature:</p>
170 | <ul class="simple">
171 | <li><p>Explain in detail how it would work.</p></li>
172 | <li><p>Keep the scope as narrow as possible, to make it easier to implement.</p></li>
173 | <li><p>Remember that this is a volunteer-driven project, and that contributions
174 | are welcome :)</p></li>
175 | </ul>
176 | </section>
177 | </section>
178 | <section id="get-started">
179 | <h3>Get Started!<a class="headerlink" href="#get-started" title="Permalink to this heading">¶</a></h3>
180 | <p>Ready to contribute? Here’s how to set up <cite>kinet2pcb</cite> for local development.</p>
181 | <ol class="arabic">
182 | <li><p>Fork the <cite>kinet2pcb</cite> repo on GitHub.</p></li>
183 | <li><p>Clone your fork locally:</p>
184 | <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>git<span class="w"> </span>clone<span class="w"> </span>git@github.com:your_name_here/kinet2pcb.git
185 | </pre></div>
186 | </div>
187 | </li>
188 | <li><p>Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:</p>
189 | <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>mkvirtualenv<span class="w"> </span>kinet2pcb
190 | $<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>kinet2pcb/
191 | $<span class="w"> </span>python<span class="w"> </span>setup.py<span class="w"> </span>develop
192 | </pre></div>
193 | </div>
194 | </li>
195 | <li><p>Create a branch for local development:</p>
196 | <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>git<span class="w"> </span>checkout<span class="w"> </span>-b<span class="w"> </span>name-of-your-bugfix-or-feature
197 | </pre></div>
198 | </div>
199 | <p>Now you can make your changes locally.</p>
200 | </li>
201 | <li><p>Commit your changes and push your branch to GitHub:</p>
202 | <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>git<span class="w"> </span>add<span class="w"> </span>.
203 | $<span class="w"> </span>git<span class="w"> </span>commit<span class="w"> </span>-m<span class="w"> </span><span class="s2">&quot;Your detailed description of your changes.&quot;</span>
204 | $<span class="w"> </span>git<span class="w"> </span>push<span class="w"> </span>origin<span class="w"> </span>name-of-your-bugfix-or-feature
205 | </pre></div>
206 | </div>
207 | </li>
208 | <li><p>Submit a pull request through the GitHub website.</p></li>
209 | </ol>
210 | </section>
211 | <section id="pull-request-guidelines">
212 | <h3>Pull Request Guidelines<a class="headerlink" href="#pull-request-guidelines" title="Permalink to this heading">¶</a></h3>
213 | <p>Before you submit a pull request, check that it meets these guidelines:</p>
214 | <ol class="arabic simple">
215 | <li><p>If the pull request adds functionality, the docs should be updated. Put
216 | your new functionality into a function with a docstring, and add the
217 | feature to the list in README.rst.</p></li>
218 | <li><p>The pull request should work for Python 2.7, and &gt;=3.6</p></li>
219 | </ol>
220 | </section>
221 | </section>
222 | <span id="document-authors"></span><section id="credits">
223 | <h2>Credits<a class="headerlink" href="#credits" title="Permalink to this heading">¶</a></h2>
224 | <section id="development-lead">
225 | <h3>Development Lead<a class="headerlink" href="#development-lead" title="Permalink to this heading">¶</a></h3>
226 | <ul class="simple">
227 | <li><p>Dave Vandenbout &lt;<a class="reference external" href="mailto:devb&#37;&#52;&#48;xess&#46;com">devb<span>&#64;</span>xess<span>&#46;</span>com</a>&gt;</p></li>
228 | </ul>
229 | </section>
230 | <section id="id1">
231 | <h3><a class="reference external" href="https://github.com/devbisme/kinet2pcb/graphs/contributors">Other Contributors</a><a class="headerlink" href="#id1" title="Permalink to this heading">¶</a></h3>
232 | </section>
233 | </section>
234 | <span id="document-history"></span><section id="history">
235 | <h2>History<a class="headerlink" href="#history" title="Permalink to this heading">¶</a></h2>
236 | <section id="id1">
237 | <h3>1.1.2 (2024-02-26)<a class="headerlink" href="#id1" title="Permalink to this heading">¶</a></h3>
238 | <ul class="simple">
239 | <li><p>Added FPID setting to part, otherwise only the fp_name and not the fp_lib appears in the final board.</p></li>
240 | <li><p>Added iterator to connect all pads of the same number to a given net. This mimics the behavior of the GUI editor.</p></li>
241 | <li><p>Added Python 3.12 to test environments.</p></li>
242 | </ul>
243 | </section>
244 | <section id="id2">
245 | <h3>1.1.1 (2023-09-10)<a class="headerlink" href="#id2" title="Permalink to this heading">¶</a></h3>
246 | <ul class="simple">
247 | <li><p><cite>net.get_pins()</cite> is now used when a SKiDL Circuit object is used as the input for generating a PCB.</p></li>
248 | </ul>
249 | </section>
250 | <section id="id3">
251 | <h3>1.1.0 (2022-08-13)<a class="headerlink" href="#id3" title="Permalink to this heading">¶</a></h3>
252 | <ul class="simple">
253 | <li><p>Added <cite>–libraries</cite> command-line option to specify footprint library directories.</p></li>
254 | </ul>
255 | </section>
256 | <section id="id4">
257 | <h3>1.0.1 (2022-06-30)<a class="headerlink" href="#id4" title="Permalink to this heading">¶</a></h3>
258 | <ul class="simple">
259 | <li><p>Fixed incompatibilities with KiCad V6 Python API (pcbnew).</p></li>
260 | </ul>
261 | </section>
262 | <section id="id5">
263 | <h3>1.0.0 (2021-09-16)<a class="headerlink" href="#id5" title="Permalink to this heading">¶</a></h3>
264 | <ul class="simple">
265 | <li><p>Decided this tool was mature to the point it could be called 1.0.0.</p></li>
266 | </ul>
267 | </section>
268 | <section id="id6">
269 | <h3>0.1.3 (2021-05-19)<a class="headerlink" href="#id6" title="Permalink to this heading">¶</a></h3>
270 | <ul class="simple">
271 | <li><p>The parts in the PCB are now given a non-overlapping arrangement
272 | grouped according to their hierarchical nesting.</p></li>
273 | </ul>
274 | </section>
275 | <section id="id7">
276 | <h3>0.1.2 (2021-05-18)<a class="headerlink" href="#id7" title="Permalink to this heading">¶</a></h3>
277 | <ul class="simple">
278 | <li><p>The <code class="docutils literal notranslate"><span class="pre">kinet2pcb()</span></code> function will now generate a KiCad PCB file when given
279 | a netlist file name, a PyParsing object, or a SKiDL Circuit object.</p></li>
280 | <li><p><code class="docutils literal notranslate"><span class="pre">kinet2pcb</span></code> can now be installed in the default Python interpreter on
281 | a system and it will look in <code class="docutils literal notranslate"><span class="pre">/usr/lib/python3/dist-packages</span></code> to find
282 | the <code class="docutils literal notranslate"><span class="pre">pcbnew</span></code> module installed by KiCad.  If the <code class="docutils literal notranslate"><span class="pre">pcbnew</span></code> module
283 | is not found there, add the correct location to the <code class="docutils literal notranslate"><span class="pre">PYTHONPATH</span></code>
284 | environment variable.</p></li>
285 | </ul>
286 | </section>
287 | <section id="id8">
288 | <h3>0.1.1 (2019-03-09)<a class="headerlink" href="#id8" title="Permalink to this heading">¶</a></h3>
289 | <ul class="simple">
290 | <li><p>Now runs under Python 2 &amp; 3.</p></li>
291 | </ul>
292 | </section>
293 | <section id="id9">
294 | <h3>0.1.0 (2019-10-28)<a class="headerlink" href="#id9" title="Permalink to this heading">¶</a></h3>
295 | <ul class="simple">
296 | <li><p>First release on PyPI.</p></li>
297 | </ul>
298 | </section>
299 | </section>
300 | </div>
301 | </section>
302 | <section id="indices-and-tables">
303 | <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this heading">¶</a></h1>
304 | <ul class="simple">
305 | <li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
306 | <li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
307 | <li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
308 | </ul>
309 | </section>
310 | 
311 | 
312 |           </div>
313 |           
314 |         </div>
315 |       </div>
316 |       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
317 |         <div class="sphinxsidebarwrapper">
318 | <h1 class="logo"><a href="#">kinet2pcb</a></h1>
319 | 
320 | 
321 | 
322 | 
323 | 
324 | 
325 | 
326 | 
327 | <h3>Navigation</h3>
328 | <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
329 | <ul>
330 | <li class="toctree-l1"><a class="reference internal" href="index.html#document-readme">kinet2pcb</a></li>
331 | <li class="toctree-l1"><a class="reference internal" href="index.html#document-installation">Installation</a></li>
332 | <li class="toctree-l1"><a class="reference internal" href="index.html#document-usage">Usage</a></li>
333 | <li class="toctree-l1"><a class="reference internal" href="index.html#document-contributing">Contributing</a></li>
334 | <li class="toctree-l1"><a class="reference internal" href="index.html#document-authors">Credits</a></li>
335 | <li class="toctree-l1"><a class="reference internal" href="index.html#document-history">History</a></li>
336 | </ul>
337 | 
338 | <div class="relations">
339 | <h3>Related Topics</h3>
340 | <ul>
341 |   <li><a href="#">Documentation overview</a><ul>
342 |   </ul></li>
343 | </ul>
344 | </div>
345 | 
346 | 
347 | 
348 | 
349 | 
350 | 
351 | 
352 | 
353 |         </div>
354 |       </div>
355 |       <div class="clearer"></div>
356 |     </div>
357 |     <div class="footer">
358 |       &copy;2019-2021, Dave Vandenbout.
359 |       
360 |       |
361 |       Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a>
362 |       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
363 |       
364 |     </div>
365 | 
366 |     
367 | 
368 |     
369 |   </body>
370 | </html>


--------------------------------------------------------------------------------
/docs/authors.rst:
--------------------------------------------------------------------------------
1 | .. include:: ../AUTHORS.rst
2 | 


--------------------------------------------------------------------------------
/docs/conf.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python
  2 | # -*- coding: utf-8 -*-
  3 | #
  4 | # kinet2pcb documentation build configuration file, created by
  5 | # sphinx-quickstart on Fri Jun  9 13:47:02 2017.
  6 | #
  7 | # This file is execfile()d with the current directory set to its
  8 | # containing dir.
  9 | #
 10 | # Note that not all possible configuration values are present in this
 11 | # autogenerated file.
 12 | #
 13 | # All configuration values have a default; values that are commented out
 14 | # serve to show the default.
 15 | 
 16 | # If extensions (or modules to document with autodoc) are in another
 17 | # directory, add these directories to sys.path here. If the directory is
 18 | # relative to the documentation root, use os.path.abspath to make it
 19 | # absolute, like shown here.
 20 | #
 21 | import os
 22 | import sys
 23 | sys.path.insert(0, os.path.abspath('..'))
 24 | sys.path.append('/usr/lib/python3/dist-packages')
 25 | 
 26 | import kinet2pcb
 27 | 
 28 | # -- General configuration ---------------------------------------------
 29 | 
 30 | # If your documentation needs a minimal Sphinx version, state it here.
 31 | #
 32 | # needs_sphinx = '1.0'
 33 | 
 34 | # Add any Sphinx extension module names here, as strings. They can be
 35 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 36 | extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
 37 | 
 38 | # Add any paths that contain templates here, relative to this directory.
 39 | templates_path = ['_templates']
 40 | 
 41 | # The suffix(es) of source filenames.
 42 | # You can specify multiple suffix as a list of string:
 43 | #
 44 | # source_suffix = ['.rst', '.md']
 45 | source_suffix = '.rst'
 46 | 
 47 | # The master toctree document.
 48 | master_doc = 'index'
 49 | 
 50 | # General information about the project.
 51 | project = u'kinet2pcb'
 52 | copyright = u"2019-2021, Dave Vandenbout"
 53 | author = u"Dave Vandenbout"
 54 | 
 55 | # The version info for the project you're documenting, acts as replacement
 56 | # for |version| and |release|, also used in various other places throughout
 57 | # the built documents.
 58 | #
 59 | # The short X.Y version.
 60 | version = kinet2pcb.pckg_info.__version__
 61 | # The full version, including alpha/beta/rc tags.
 62 | release = kinet2pcb.pckg_info.__version__
 63 | 
 64 | # The language for content autogenerated by Sphinx. Refer to documentation
 65 | # for a list of supported languages.
 66 | #
 67 | # This is also used if you do content translation via gettext catalogs.
 68 | # Usually you set "language" from the command line for these cases.
 69 | language = None
 70 | 
 71 | # List of patterns, relative to source directory, that match files and
 72 | # directories to ignore when looking for source files.
 73 | # This patterns also effect to html_static_path and html_extra_path
 74 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 75 | 
 76 | # The name of the Pygments (syntax highlighting) style to use.
 77 | pygments_style = 'sphinx'
 78 | 
 79 | # If true, `todo` and `todoList` produce output, else they produce nothing.
 80 | todo_include_todos = False
 81 | 
 82 | 
 83 | # -- Options for HTML output -------------------------------------------
 84 | 
 85 | # The theme to use for HTML and HTML Help pages.  See the documentation for
 86 | # a list of builtin themes.
 87 | #
 88 | html_theme = 'alabaster'
 89 | 
 90 | # Theme options are theme-specific and customize the look and feel of a
 91 | # theme further.  For a list of options available for each theme, see the
 92 | # documentation.
 93 | #
 94 | # html_theme_options = {}
 95 | 
 96 | # Add any paths that contain custom static files (such as style sheets) here,
 97 | # relative to this directory. They are copied after the builtin static files,
 98 | # so a file named "default.css" will overwrite the builtin "default.css".
 99 | html_static_path = ['_static']
100 | 
101 | 
102 | # -- Options for HTMLHelp output ---------------------------------------
103 | 
104 | # Output file base name for HTML help builder.
105 | htmlhelp_basename = 'kinet2brddoc'
106 | 
107 | 
108 | # -- Options for LaTeX output ------------------------------------------
109 | 
110 | latex_elements = {
111 |     # The paper size ('letterpaper' or 'a4paper').
112 |     #
113 |     # 'papersize': 'letterpaper',
114 | 
115 |     # The font size ('10pt', '11pt' or '12pt').
116 |     #
117 |     # 'pointsize': '10pt',
118 | 
119 |     # Additional stuff for the LaTeX preamble.
120 |     #
121 |     # 'preamble': '',
122 | 
123 |     # Latex figure (float) alignment
124 |     #
125 |     # 'figure_align': 'htbp',
126 | }
127 | 
128 | # Grouping the document tree into LaTeX files. List of tuples
129 | # (source start file, target name, title, author, documentclass
130 | # [howto, manual, or own class]).
131 | latex_documents = [
132 |     (master_doc, 'kinet2pcb.tex',
133 |      u'kinet2pcb Documentation',
134 |      u'Dave Vandenbout', 'manual'),
135 | ]
136 | 
137 | 
138 | # -- Options for manual page output ------------------------------------
139 | 
140 | # One entry per manual page. List of tuples
141 | # (source start file, name, description, authors, manual section).
142 | man_pages = [
143 |     (master_doc, 'kinet2pcb',
144 |      u'kinet2pcb Documentation',
145 |      [author], 1)
146 | ]
147 | 
148 | 
149 | # -- Options for Texinfo output ----------------------------------------
150 | 
151 | # Grouping the document tree into Texinfo files. List of tuples
152 | # (source start file, target name, title, author,
153 | #  dir menu entry, description, category)
154 | texinfo_documents = [
155 |     (master_doc, 'kinet2pcb',
156 |      u'kinet2pcb Documentation',
157 |      author,
158 |      'kinet2pcb',
159 |      'One line description of project.',
160 |      'Miscellaneous'),
161 | ]
162 | 
163 | 
164 | 
165 | 


--------------------------------------------------------------------------------
/docs/contributing.rst:
--------------------------------------------------------------------------------
1 | .. include:: ../CONTRIBUTING.rst
2 | 


--------------------------------------------------------------------------------
/docs/history.rst:
--------------------------------------------------------------------------------
1 | .. include:: ../HISTORY.rst
2 | 


--------------------------------------------------------------------------------
/docs/index.rst:
--------------------------------------------------------------------------------
 1 | Welcome to kinet2pcb's documentation!
 2 | ======================================
 3 | 
 4 | .. toctree::
 5 |    :maxdepth: 2
 6 |    :caption: Contents:
 7 | 
 8 |    readme
 9 |    installation
10 |    usage
11 |    modules
12 |    contributing
13 |    authors
14 |    history
15 | 
16 | Indices and tables
17 | ==================
18 | * :ref:`genindex`
19 | * :ref:`modindex`
20 | * :ref:`search`
21 | 


--------------------------------------------------------------------------------
/docs/installation.rst:
--------------------------------------------------------------------------------
 1 | .. highlight:: shell
 2 | 
 3 | ============
 4 | Installation
 5 | ============
 6 | 
 7 | This is a Python package, and it requires the ``pcbnew`` module included with KiCad.
 8 | Therefore, you'll have to install it using the ``pip`` executable included in the 
 9 | KiCad ``bin`` directory like so:
10 | 
11 | .. code-block:: console
12 | 
13 |     $ pip install kinet2pcb
14 | 
15 | This is the preferred method to install ``kinet2pcb``, as it will always install the most recent stable release.
16 | 
17 | You can also install ``kinet2pcb`` in the Python interpreter on your system using its ``pip`` command,
18 | but your system libraries probably won't include the ``pcbnew`` module.
19 | By default, ``kinet2pcb`` adds ``/usr/lib/python3/dist-packages`` to the Python library
20 | search path which is where KiCad normally stores ``pcbnew`` in a linux system.
21 | If your system doesn't follow this convention, then you'll have to search for
22 | the ``pcbnew.py`` file and add its path to the ``PYTHONPATH`` environment variable.
23 | 


--------------------------------------------------------------------------------
/docs/make.bat:
--------------------------------------------------------------------------------
 1 | @ECHO OFF
 2 | 
 3 | pushd %~dp0
 4 | 
 5 | REM Command file for Sphinx documentation
 6 | 
 7 | if "%SPHINXBUILD%" == "" (
 8 | 	set SPHINXBUILD=python -msphinx
 9 | )
10 | set SOURCEDIR=.
11 | set BUILDDIR=_build
12 | set SPHINXPROJ=kinet2pcb
13 | 
14 | if "%1" == "" goto help
15 | 
16 | %SPHINXBUILD% >NUL 2>NUL
17 | if errorlevel 9009 (
18 | 	echo.
19 | 	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
20 | 	echo.then set the SPHINXBUILD environment variable to point to the full
21 | 	echo.path of the 'sphinx-build' executable. Alternatively you may add the
22 | 	echo.Sphinx directory to PATH.
23 | 	echo.
24 | 	echo.If you don't have Sphinx installed, grab it from
25 | 	echo.http://sphinx-doc.org/
26 | 	exit /b 1
27 | )
28 | 
29 | %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
30 | goto end
31 | 
32 | :help
33 | %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
34 | 
35 | :end
36 | popd
37 | 


--------------------------------------------------------------------------------
/docs/readme.rst:
--------------------------------------------------------------------------------
1 | .. include:: ../README.rst
2 | 


--------------------------------------------------------------------------------
/docs/usage.rst:
--------------------------------------------------------------------------------
 1 | =====
 2 | Usage
 3 | =====
 4 | 
 5 | ``kinet2pcb`` can be used as a module to provide other scripts with the ability
 6 | to create KiCad PCB files, but it is mainly intended to serve as its own stand-alone utility::
 7 | 
 8 |     usage: kinet2pcb [-h] [--version] [--input file] [--output [file]] [--overwrite] [--nobackup]
 9 |                     [--libraries footprint_dir [footprint_dir ...]] [--debug [LEVEL]]
10 | 
11 |     Convert KiCad netlist into a PCBNEW .kicad_pcb file.
12 | 
13 |     optional arguments:
14 |     -h, --help            show this help message and exit
15 |     --version, -v         show program's version number and exit
16 |     --input file, -i file
17 |                             Input file containing KiCad netlist.
18 |     --output [file], -o [file]
19 |                             Output file for storing KiCad board.
20 |     --overwrite, -w       Allow overwriting of an existing board file.
21 |     --nobackup, -nb       Do *not* create backups before modifying files. (Default is to make backup files.)
22 |     --libraries footprint_dir [footprint_dir ...], -l footprint_dir [footprint_dir ...]
23 |                             Specify one or more directories containing .pretty footprint libraries.
24 |     --debug [LEVEL], -d [LEVEL]
25 |                             Print debugging info. (Larger LEVEL means more info.)
26 | 
27 | -----------
28 | Examples
29 | -----------
30 | 
31 | Assuming you've generated a KiCad netlist file called ``example.net``, then
32 | the following command would create a KiCad PCB file called ``example.kicad_pcb``::
33 | 
34 |     kinet2pcb -i example.net
35 | 
36 | If a files called ``example.kicad_pcb`` already exists, then ``kinet2pcb`` will
37 | halt and not over-write the file. To override this behavior, use the ``-w`` option::
38 | 
39 |     kinet2pcb -i example.net -w
40 | 
41 | The above command will rename the pre-existing ``example.kicad_pcb`` file to
42 | ``example.kicad_pcb.bak``.
43 | 
44 | If you have one or more libraries of part footprints that are not listed in your
45 | KiCad ``fp-lib-tables`` file, you can specify them on the command line like so::
46 | 
47 |     kinet2pcb -i example.net --libraries /my/path/to/lib_1.pretty /my/path/to/lib2.pretty
48 | 
49 | If you have a lot of libraries that are all stored in a single directory, then
50 | you can shorten the command by just listing the parent directory:
51 | 
52 |     kinet2pcb -i example.net --libraries /my/path/to
53 | 
54 | 
55 | ----------------------------
56 | Preventing Disasters
57 | ----------------------------
58 | 
59 | A lot of work goes into creating a PCB.
60 | For this reason, ``kinet2pcb`` makes a backup of any ``.kicad_pcb`` file it is about to overwrite
61 | (using file names such as ``example.1.kicad_pcb``, ``example.2.kicad_pcb``, etc.).
62 | You can turn off this behavior using the ``--nobackup`` option.
63 | 
64 | In addition, if ``kinet2pcb`` would overwrite an existing ``.kicad_pcb`` file
65 | and the ``--nobackup`` option is enabled, then you must also use the ``--overwrite`` option
66 | or the operation will be aborted.
67 | 


--------------------------------------------------------------------------------
/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE HTML>
 2 | <html lang="en-US">
 3 |     <head>
 4 |         <meta charset="UTF-8">
 5 |         <meta http-equiv="refresh" content="0;url=docs/_build/singlehtml/index.html">
 6 |         <script type="text/javascript">
 7 |             window.location.href = "docs/_build/singlehtml/index.html"
 8 |         </script>
 9 |         <title>Page Redirection</title>
10 |     </head>
11 |     <body>
12 |         <!-- Note: don't tell people to `click` the link, just tell them that it is a link. -->
13 |         If you are not redirected automatically, follow the <a href='docs/_build/singlehtml/index.html'>link to example</a>
14 |     </body>
15 | </html>
16 | 


--------------------------------------------------------------------------------
/kinet2pcb/__init__.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | 
3 | """Top-level package for kinet2pcb."""
4 | 
5 | from .kinet2pcb import *
6 | from .pckg_info import __version__
7 | 


--------------------------------------------------------------------------------
/kinet2pcb/kinet2pcb.py:
--------------------------------------------------------------------------------
  1 | # -*- coding: utf-8 -*-
  2 | 
  3 | 
  4 | import argparse
  5 | import logging
  6 | import os
  7 | import os.path
  8 | import re
  9 | import shutil
 10 | import sys
 11 | 
 12 | import simp_sexp
 13 | 
 14 | if os.name == "posix":
 15 |     sys.path.append('/usr/lib/python3/dist-packages')
 16 | elif os.name == "nt":
 17 |     for kicad_version in ("9.0", "8.0", "7.0", "6.0", "5.0"):
 18 |         ki_pth = os.path.join("C:\\Program Files\\KiCad", kicad_version)
 19 |         if os.path.isdir(ki_pth):
 20 |             sys.path.extend((os.path.join(ki_pth, "bin"), os.path.join(ki_pth, "bin", "Lib", "site-packages")))
 21 |             break
 22 |     else:
 23 |         raise Exception("Warning: Could not find KiCad installation to import pcbnew module.")
 24 | 
 25 | import pcbnew
 26 | import hierplace
 27 | 
 28 | from .pckg_info import __version__
 29 | 
 30 | # Global logger.
 31 | logger = logging.getLogger("kinet2pcb")
 32 | 
 33 | def rmv_quotes(s):
 34 |     """Remove starting and ending quotes from a string."""
 35 |     if not isinstance(s, str):
 36 |         return s
 37 | 
 38 |     mtch = re.match(r'^\s*"(.*)"\s*$', s)
 39 |     if mtch:
 40 |         try:
 41 |             s = s.decode(mtch.group(1))
 42 |         except (AttributeError, LookupError):
 43 |             s = mtch.group(1)
 44 | 
 45 |     return s
 46 | 
 47 | 
 48 | def to_list(x):
 49 |     """
 50 |     Return x if it is already a list, return a list containing x if x is a scalar unless
 51 |     x is None in which case return an empty list.
 52 |     """
 53 |     if x is None:
 54 |         # Return empty list if x is None.
 55 |         return []
 56 |     if isinstance(x, (list, tuple)):
 57 |         return x  # Already a list, so just return it.
 58 |     return [x]  # Wasn't a list, so make it into one.
 59 | 
 60 | 
 61 | def get_global_fp_lib_table_fn():
 62 |     """Get the full path of the global fp-lib-table file or return an empty string."""
 63 | 
 64 |     kicad_versions = ("9.0", "8.0", "7.0", "6.0", "5.0", "")
 65 |     paths = (
 66 |         "$HOME/.config/kicad",
 67 |         "~/.config/kicad",
 68 |         "%APPDATA%/kicad",
 69 |         "$HOME/Library/Preferences/kicad",
 70 |         "~/Library/Preferences/kicad",
 71 |         "%ProgramFiles%/KiCad/share/kicad/template",
 72 |         "/usr/share/kicad/template",
 73 |     )
 74 |     for version in kicad_versions:
 75 |         for path in paths:
 76 |             path = os.path.normpath(os.path.expanduser(os.path.expandvars(path)))
 77 |             fp_lib_table_fn = os.path.join(path, version, 'fp-lib-table')
 78 |             if os.path.exists(fp_lib_table_fn):
 79 |                 return fp_lib_table_fn
 80 | 
 81 |     logger.warning("Unable to find global fp-lib-table file.")
 82 |     return ""
 83 | 
 84 | 
 85 | class LibURIs(dict):
 86 |     """Dict for storing library URIs from all directories in fp-lib-table file."""
 87 | 
 88 |     def __init__(self, *fp_lib_table_fns):
 89 |         super(self.__class__, self).__init__()
 90 | 
 91 |         # Set KISYSMOD to a default value if it isn't already defined.
 92 |         if 'KISYSMOD' not in os.environ.keys():
 93 |             if os.name == 'nt':
 94 |                 os.environ['KISYSMOD'] = '%ProgramFiles%/KiCad/share/kicad/modules'
 95 |             else:
 96 |                 os.environ['KISYSMOD'] = '/usr/share/kicad/modules'
 97 | 
 98 |         # Load URIs for libraries found in each library table file.
 99 |         for fp_lib_table_fn in fp_lib_table_fns:
100 |             self.load(fp_lib_table_fn)
101 | 
102 |     def load(self, fp_lib_table_fn):
103 |         """Load cache with URIs for libraries in fp-lib-table file."""
104 | 
105 |         # Read contents of footprint library file into a single string.
106 |         try:
107 |             with open(fp_lib_table_fn) as fp:
108 |                 tbl = fp.read()
109 |         except IOError:
110 |             return
111 | 
112 |         # Get individual "(lib ...)" entries from the string.
113 |         libs = re.findall(
114 |             r"\(\s*lib\s* .*? \)\)", tbl, flags=re.IGNORECASE | re.VERBOSE | re.DOTALL
115 |         )
116 | 
117 |         # Add the footprint modules found in each enabled KiCad library.
118 |         for lib in libs:
119 | 
120 |             # Skip disabled libraries.
121 |             disabled = re.findall(
122 |                 r"\(\s*disabled\s*\)", lib, flags=re.IGNORECASE | re.VERBOSE
123 |             )
124 |             if disabled:
125 |                 continue
126 | 
127 |             # Skip non-KiCad libraries (primarily git repos).
128 |             type_ = re.findall(
129 |                 r'(?:\(\s*type\s*) ("[^"]*?"|[^)]*?) (?:\s*\))',
130 |                 lib,
131 |                 flags=re.IGNORECASE | re.VERBOSE,
132 |             )[0]
133 |             if type_.lower() != "kicad":
134 |                 continue
135 | 
136 |             # Get the library directory and nickname.
137 |             uri = re.findall(
138 |                 r'(?:\(\s*uri\s*) ("[^"]*?"|[^)]*?) (?:\s*\))',
139 |                 lib,
140 |                 flags=re.IGNORECASE | re.VERBOSE,
141 |             )[0]
142 |             nickname = re.findall(
143 |                 r'(?:\(\s*name\s*) ("[^"]*?"|[^)]*?) (?:\s*\))',
144 |                 lib,
145 |                 flags=re.IGNORECASE | re.VERBOSE,
146 |             )[0]
147 | 
148 |             # Remove any quotes around the URI or nickname.
149 |             uri = rmv_quotes(uri)
150 |             nickname = rmv_quotes(nickname)
151 | 
152 |             # Expand variables and ~ in the URI.
153 |             uri = os.path.expandvars(os.path.expanduser(uri))
154 | 
155 |             if nickname in self:
156 |                 print("Overwriting {nickname}:{self[nickname]} with {nickname}:{uri}".format(**locals()))
157 |             self[nickname] = uri
158 | 
159 | 
160 | def get_user_lib_uris(fp_lib_dirs):
161 |     """Return a dict of .pretty footprint library nicknames and their absolute directory names.
162 | 
163 |     Args:
164 |         fp_lib_dirs (list/str): Single or list of directory paths to search for footprint libraries.
165 | 
166 |     Returns:
167 |         Dictionary with library nicknames as keys and library directories as values.
168 |     """
169 | 
170 |     def add_lib(dir):
171 |         """Add a directory as a footprint library if it ends with ".pretty"."""
172 | 
173 |         # Get the extension of the directory name.
174 |         _, basename = os.path.split(dir)
175 |         base, ext = os.path.splitext(basename)
176 | 
177 |         if ext.lower() == ".pretty":
178 |             # Add directory using the base of the file name as the library nickname.
179 |             user_lib_uris[base] = dir
180 |             return True  # Directory was added as a footprint library.
181 | 
182 |         return False # Directory was not a footprint library.
183 | 
184 |     user_lib_uris = dict()
185 | 
186 |     for dir in to_list(fp_lib_dirs):
187 | 
188 |         # Fully expand the directory path.
189 |         dir = os.path.abspath(os.path.expandvars(os.path.expanduser(dir)))
190 | 
191 |         if not add_lib(dir):
192 |             # If the dir wasn't a footprint library, then see if it contains
193 |             # any footprint libraries and add those.
194 |             for subdir in os.listdir(dir):
195 |                 add_lib(os.path.join(dir, subdir))
196 | 
197 |     return user_lib_uris
198 | 
199 | 
200 | class NetlistPart:
201 |     """Simple container for netlist part information."""
202 |     def __init__(self, ref, value, footprint, sheetpath=None):
203 |         self.ref = ref
204 |         self.value = value
205 |         self.footprint = footprint
206 |         self.sheetpath = sheetpath or SimpleNamespace(names="")
207 | 
208 | class NetlistPin:
209 |     """Simple container for netlist pin information."""
210 |     def __init__(self, ref, num):
211 |         self.ref = ref
212 |         self.num = num
213 | 
214 | class NetlistNet:
215 |     """Simple container for netlist net information."""
216 |     def __init__(self, name, pins=None):
217 |         self.name = name
218 |         self.pins = pins or []
219 | 
220 | class SimpleNamespace:
221 |     """Simple namespace object for sheetpath."""
222 |     def __init__(self, **kwargs):
223 |         self.__dict__.update(kwargs)
224 | 
225 | def parse_netlist(netlist_filename):
226 |     """Parse a KiCad netlist file using simp_sexp."""
227 |     
228 |     class Netlist:
229 |         def __init__(self):
230 |             self.parts = []
231 |             self.nets = []
232 |     
233 |     with open(netlist_filename, 'r') as f:
234 |         netlist_data = f.read()
235 |     
236 |     # Parse the S-expression
237 |     parsed = simp_sexp.Sexp(netlist_data)
238 |     
239 |     netlist = Netlist()
240 |     
241 |     # Search for components using simp_sexp search
242 |     comp_nodes = parsed.search('export/components/comp')
243 |     for comp in comp_nodes:
244 |         ref_results = comp.search('ref')
245 |         value_results = comp.search('value')
246 |         footprint_results = comp.search('footprint')
247 |         
248 |         ref = ref_results.value if ref_results else None
249 |         value = value_results.value if value_results else None
250 |         footprint = footprint_results.value if footprint_results else None
251 |         
252 |         if ref and footprint:
253 |             part = NetlistPart(ref, value or "", footprint)
254 |             netlist.parts.append(part)
255 |     
256 |     # Search for nets using simp_sexp search
257 |     net_nodes = parsed.search('export/nets/net')
258 |     for net_node in net_nodes:
259 |         name_results = net_node.search('name')
260 |         net_name = name_results.value if name_results else None
261 |         
262 |         if net_name:
263 |             pins = []
264 |             # Search for all node entries within this net
265 |             node_entries = net_node.search('node')
266 |             for node in node_entries:
267 |                 ref_results = node.search('ref')
268 |                 pin_results = node.search('pin')
269 | 
270 |                 ref = ref_results.value if ref_results else None
271 |                 pin_num = pin_results.value if pin_results else None
272 |                 
273 |                 if ref and pin_num:
274 |                     pins.append(NetlistPin(ref, pin_num))
275 |             
276 |             net = NetlistNet(net_name, pins)
277 |             netlist.nets.append(net)
278 |     
279 |     return netlist
280 | 
281 | def kinet2pcb(netlist_origin, brd_filename, fp_lib_dirs=None):
282 |     """Create a .kicad_pcb from a KiCad netlist file.
283 | 
284 |     Args:
285 |         netlist_origin (netlist filename or Circuit object): Netlist for circuit.
286 |         brd_filename (str): Name of file to hold KiCad PCB.
287 |         user_lib_dirs (list, optional): List of footprint library directories. Defaults to None.
288 |     """
289 | 
290 |     # Get the global and local fp-lib-table footprint library URIs.
291 |     fp_libs = LibURIs(get_global_fp_lib_table_fn(), os.path.join(".", "fp-lib-table"))
292 | 
293 |     # Add the footprint libraries from user-supplied directories.
294 |     fp_libs.update(get_user_lib_uris(fp_lib_dirs))
295 | 
296 |     # Create a blank KiCad PCB.
297 |     brd = pcbnew.BOARD()
298 | 
299 |     # Get the netlist.
300 |     if isinstance(netlist_origin, type('')):
301 |         # Parse the netlist into an object if given a file name string.
302 |         netlist = parse_netlist(netlist_origin)
303 |     else:
304 |         # otherwise, the netlist is already an object that can be processed directly.
305 |         netlist = netlist_origin
306 | 
307 |     # Add the components in the netlist to the PCB.
308 |     for part in netlist.parts:
309 | 
310 |         # Get the library and footprint name for the part.
311 |         fp_lib, fp_name = part.footprint.split(":")
312 | 
313 |         # Get the URI of the library directory.
314 |         lib_uri = fp_libs[fp_lib]
315 | 
316 |         # Create a module from the footprint file.
317 |         fp = pcbnew.FootprintLoad(lib_uri, fp_name)
318 |         if not fp:
319 |             # Could not find footprint so give warning and skip to next part.
320 |             logger.warning("Unable to find footprint {fp_name} in {lib_uri}".format(**locals()))
321 |             continue
322 | 
323 |         # Set the module parameters based on the part data.
324 |         fp.SetParent(brd)
325 |         fp.SetReference(part.ref)
326 |         fp.SetValue(part.value)
327 |         fp.SetFPIDAsString(part.footprint)
328 |         # fp.SetTimeStamp(part.sheetpath.tstamps)
329 |         try:
330 |             # Newer PCBNEW API.
331 |             fp.SetPath(pcbnew.KIID_PATH(part.sheetpath.names))
332 |         except TypeError:
333 |             # Older PCBNEW API.
334 |             fp.SetPath(part.sheetpath.names)
335 |         except AttributeError:
336 |             pass
337 | 
338 |         # Add the module to the PCB.
339 |         brd.Add(fp)
340 | 
341 |     # Add the nets in the netlist to the PCB.
342 |     cnct = brd.GetConnectivity()
343 |     for net in netlist.nets:
344 | 
345 |         # Create a net with the current net name.
346 |         pcb_net = pcbnew.NETINFO_ITEM(brd, net.name)
347 | 
348 |         # Add the net to the PCB.
349 |         brd.Add(pcb_net)
350 | 
351 |         # Get list of pins connected to net.
352 |         try:
353 |             # When handling a SKiDL Net object.
354 |             pins = net.get_pins()
355 |         except AttributeError:
356 |             # When handling a ParseResults object.
357 |             pins = net.pins
358 | 
359 |         # Connect the part pins on the netlist net to the PCB net.
360 |         for pin in pins:
361 |             try:
362 |                 # Newer PCBNEW API.
363 |                 # Find the PCB footprint for the current pin and then connect all pads
364 |                 # with that number to the net.
365 |                 module = brd.FindFootprintByReference(pin.ref)
366 |                 if module:
367 |                     pad = None
368 |                     while True:
369 |                         pad = module.FindPadByNumber(pin.num, pad)
370 |                         if pad:
371 |                             cnct.Add(pad)
372 |                             pad.SetNet(pcb_net)
373 |                         else:
374 |                             break # Done with all pads for this pin number.
375 | 
376 |             except AttributeError:
377 |                 # Older PCBNEW API.
378 |                 # Find the PCB module for the current pin and then connect its pad to the net.
379 |                 module = brd.FindModuleByReference(pin.ref)
380 |                 if module:
381 |                     pad = module.FindPadByName(pin.num)
382 |                     if pad:
383 |                         cnct.Add(pad)
384 |                         pad.SetNet(pcb_net)
385 | 
386 |     # Recalculate the PCB part and net data.
387 |     brd.BuildListOfNets()
388 |     cnct.RecalculateRatsnest()
389 |     pcbnew.Refresh()
390 | 
391 |     # Place the board parts into non-overlapping areas that follow the design hierarchy.
392 |     hierplace.hier_place(brd)
393 | 
394 |     # Save the PCB into the KiCad PCB file.
395 |     pcbnew.SaveBoard(brd_filename, brd)
396 | 
397 | 
398 | ###############################################################################
399 | # Command-line interface.
400 | ###############################################################################
401 | 
402 | 
403 | def main():
404 |     parser = argparse.ArgumentParser(
405 |         description="""Convert KiCad netlist into a PCBNEW .kicad_pcb file."""
406 |     )
407 |     parser.add_argument(
408 |         "--version", "-v", action="version", version="kinet2pcb " + __version__
409 |     )
410 |     parser.add_argument(
411 |         "--input",
412 |         "-i",
413 |         type=str,
414 |         metavar="file",
415 |         help="""Input file containing KiCad netlist.""",
416 |     )
417 |     parser.add_argument(
418 |         "--output",
419 |         "-o",
420 |         nargs="?",
421 |         type=str,
422 |         metavar="file",
423 |         help="""Output file for storing KiCad board.""",
424 |     )
425 |     parser.add_argument(
426 |         "--overwrite",
427 |         "-w",
428 |         action="store_true",
429 |         help="Allow overwriting of an existing board file.",
430 |     )
431 |     parser.add_argument(
432 |         "--nobackup",
433 |         "-nb",
434 |         action="store_true",
435 |         help="""Do *not* create backups before modifying files.
436 |             (Default is to make backup files.)""",
437 |     )
438 |     parser.add_argument(
439 |         "--libraries",
440 |         "-l",
441 |         nargs="+",
442 |         type=str,
443 |         metavar="footprint_dir",
444 |         help="Specify one or more directories containing .pretty footprint libraries."
445 |     )
446 |     parser.add_argument(
447 |         "--debug",
448 |         "-d",
449 |         nargs="?",
450 |         type=int,
451 |         default=0,
452 |         metavar="LEVEL",
453 |         help="Print debugging info. (Larger LEVEL means more info.)",
454 |     )
455 | 
456 |     args = parser.parse_args()
457 | 
458 |     if args.debug is not None:
459 |         log_level = logging.DEBUG + 1 - args.debug
460 |         handler = logging.StreamHandler(sys.stdout)
461 |         handler.setLevel(log_level)
462 |         logger.addHandler(handler)
463 |         logger.setLevel(log_level)
464 | 
465 |     if args.output is None:
466 |         args.output = os.path.splitext(args.input)[0] + ".kicad_pcb"
467 | 
468 |     if os.path.isfile(args.output):
469 |         if not args.overwrite and args.nobackup:
470 |             logger.critical(
471 |                 """File {} already exists! Use the --overwrite option to
472 |                 allow modifications to it or allow backups.""".format(
473 |                     args.output
474 |                 )
475 |             )
476 |             sys.exit(1)
477 |         if not args.nobackup:
478 |             # Create a backup file.
479 |             index = 1  # Start with this backup file suffix.
480 |             while True:
481 |                 backup_file = args.output + ".{}.bak".format(index)
482 |                 if not os.path.isfile(backup_file):
483 |                     # Found an unused backup file name, so make backup.
484 |                     shutil.copy(args.output, backup_file)
485 |                     break  # Backup done, so break out of loop.
486 |                 index += 1  # Else keep looking for an unused backup file name.
487 | 
488 |     kinet2pcb(args.input, args.output, args.libraries)
489 | 
490 | 
491 | ###############################################################################
492 | # Main entrypoint.
493 | ###############################################################################
494 | if __name__ == "__main__":
495 |     main()
496 | 


--------------------------------------------------------------------------------
/kinet2pcb/pckg_info.py:
--------------------------------------------------------------------------------
1 | __version__ = '1.1.3'
2 | __author__ = 'Dave Vandenbout'
3 | __email__ = 'dave@vdb.name'
4 | 


--------------------------------------------------------------------------------
/notes.txt:
--------------------------------------------------------------------------------
1 | 1. .nojekyll allows Github pages to scan directories whose names start with "_".
2 |    Remove it if you are using a Jekyll theme on web pages that are not stored
3 |    in _build/singlehtml.


--------------------------------------------------------------------------------
/publish.sh:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env bash
 2 | set -euo pipefail
 3 | 
 4 | tox -e docs
 5 | rm -f dist/*.gz
 6 | python setup.py sdist
 7 | python -m twine check dist/*
 8 | python -m twine upload --repository pypi dist/*
 9 | git tag -f `kinet2pcb -v | cut -d' ' -f2`
10 | git push
11 | 


--------------------------------------------------------------------------------
/requirements_dev.txt:
--------------------------------------------------------------------------------
 1 | pip==21.1
 2 | bumpversion==0.5.3
 3 | wheel==0.38.1
 4 | watchdog==0.9.0
 5 | flake8==3.5.0
 6 | tox==3.5.2
 7 | coverage==4.5.1
 8 | Sphinx==1.8.1
 9 | twine==1.12.1
10 | 
11 | pytest==3.8.2
12 | pytest-runner==4.2
13 | 


--------------------------------------------------------------------------------
/setup.cfg:
--------------------------------------------------------------------------------
 1 | ; [bumpversion]
 2 | ; current_version = 0.1.0
 3 | ; commit = True
 4 | ; tag = True
 5 | 
 6 | ; [bumpversion:file:setup.py]
 7 | ; search = version='{current_version}'
 8 | ; replace = version='{new_version}'
 9 | 
10 | ; [bumpversion:file:kinet2pcb/__init__.py]
11 | ; search = __version__ = '{current_version}'
12 | ; replace = __version__ = '{new_version}'
13 | 
14 | [bdist_wheel]
15 | universal = 1
16 | 
17 | ; [flake8]
18 | ; exclude = docs
19 | 
20 | ; [aliases]
21 | ; # Define setup.py command aliases here
22 | ; test = pytest
23 | 
24 | ; [tool:pytest]
25 | ; collect_ignore = ['setup.py']
26 | 
27 | 


--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env python
 2 | # -*- coding: utf-8 -*-
 3 | 
 4 | import sys
 5 | from setuptools import setup, find_packages
 6 | 
 7 | __author__ = "Dave Vandenbout"
 8 | __email__ = "dave@vdb.name"
 9 | __version__ = "1.1.4"
10 | 
11 | if "sdist" in sys.argv[1:]:
12 |     with open("kinet2pcb/pckg_info.py", "w") as f:
13 |         for name in ["__version__", "__author__", "__email__"]:
14 |             f.write("{} = '{}'\n".format(name, locals()[name]))
15 | 
16 | with open("README.rst") as readme_file:
17 |     readme = readme_file.read()
18 | 
19 | with open("HISTORY.rst") as history_file:
20 |     history = history_file.read()
21 | 
22 | requirements = [
23 |     "simp_sexp",
24 |     "hierplace",
25 | ]
26 | 
27 | setup_requirements = [
28 |     "pytest-runner",
29 | ]
30 | 
31 | test_requirements = [
32 |     "pytest",
33 | ]
34 | 
35 | setup(
36 |     author=__author__,
37 |     author_email=__email__,
38 |     version=__version__,
39 |     classifiers=[
40 |         "Development Status :: 5 - Production/Stable",
41 |         "Intended Audience :: Manufacturing",
42 |         "License :: OSI Approved :: MIT License",
43 |         "Natural Language :: English",
44 |         "Operating System :: OS Independent",
45 |         "Programming Language :: Python :: 3",
46 |         "Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)",
47 |     ],
48 |     description="Convert KiCad netlist into a PCBNEW .kicad_pcb file.",
49 |     entry_points={
50 |         "console_scripts": [
51 |             "kinet2pcb=kinet2pcb.kinet2pcb:main",
52 |         ],
53 |     },
54 |     install_requires=requirements,
55 |     license="MIT license",
56 |     long_description=readme + "\n\n" + history,
57 |     include_package_data=True,
58 |     keywords="kinet2pcb KiCad EDA PCBNEW SKiDL",
59 |     name="kinet2pcb",
60 |     packages=find_packages(include=["kinet2pcb"]),
61 |     python_requires='>=3.6',
62 |     setup_requires=setup_requirements,
63 |     test_suite="tests",
64 |     tests_require=test_requirements,
65 |     url="https://github.com/devbisme/kinet2pcb",
66 |     project_urls={
67 |         "Documentation": "https://devbisme.github.io/kinet2pcb",
68 |         "Source": "https://github.com/devbisme/kinet2pcb",
69 |         "Changelog": "https://github.com/devbisme/kinet2pcb/blob/master/HISTORY.rst",
70 |         "Tracker": "https://github.com/devbisme/kinet2pcb/issues",
71 |     },
72 |     zip_safe=False,
73 | )
74 | 


--------------------------------------------------------------------------------
/tests/conftest.py:
--------------------------------------------------------------------------------
1 | import os
2 | import os.path
3 | import pdb
4 | import sys
5 | 


--------------------------------------------------------------------------------
/tests/kinet2pcb_test/kinet2pcb_test.net:
--------------------------------------------------------------------------------
 1 | (export (version D)
 2 |   (design
 3 |     (source C:\TEMP\kinet2pcb_test\kinet2pcb_test.sch)
 4 |     (date "11/01/2019 9:59:58 AM")
 5 |     (tool "Eeschema (5.1.4)-1")
 6 |     (sheet (number 1) (name /) (tstamps /)
 7 |       (title_block
 8 |         (title)
 9 |         (company)
10 |         (rev)
11 |         (date)
12 |         (source kinet2pcb_test.sch)
13 |         (comment (number 1) (value ""))
14 |         (comment (number 2) (value ""))
15 |         (comment (number 3) (value ""))
16 |         (comment (number 4) (value "")))))
17 |   (components
18 |     (comp (ref C1)
19 |       (value C)
20 |       (footprint Capacitor_SMD:CP_Elec_5x3)
21 |       (datasheet ~)
22 |       (libsource (lib Device) (part C) (description "Unpolarized capacitor"))
23 |       (sheetpath (names /) (tstamps /))
24 |       (tstamp 5DBC3998))
25 |     (comp (ref D1)
26 |       (value LED)
27 |       (footprint LED_SMD:LED_0201_0603Metric)
28 |       (datasheet ~)
29 |       (libsource (lib Device) (part LED) (description "Light emitting diode"))
30 |       (sheetpath (names /) (tstamps /))
31 |       (tstamp 5DBC3E23))
32 |     (comp (ref R1)
33 |       (value R)
34 |       (footprint Resistor_SMD:R_0603_1608Metric)
35 |       (datasheet ~)
36 |       (libsource (lib Device) (part R) (description Resistor))
37 |       (sheetpath (names /) (tstamps /))
38 |       (tstamp 5DBC51E3)))
39 |   (libparts
40 |     (libpart (lib Device) (part C)
41 |       (description "Unpolarized capacitor")
42 |       (docs ~)
43 |       (footprints
44 |         (fp C_*))
45 |       (fields
46 |         (field (name Reference) C)
47 |         (field (name Value) C))
48 |       (pins
49 |         (pin (num 1) (name ~) (type passive))
50 |         (pin (num 2) (name ~) (type passive))))
51 |     (libpart (lib Device) (part LED)
52 |       (description "Light emitting diode")
53 |       (docs ~)
54 |       (footprints
55 |         (fp LED*)
56 |         (fp LED_SMD:*)
57 |         (fp LED_THT:*))
58 |       (fields
59 |         (field (name Reference) D)
60 |         (field (name Value) LED))
61 |       (pins
62 |         (pin (num 1) (name K) (type passive))
63 |         (pin (num 2) (name A) (type passive))))
64 |     (libpart (lib Device) (part R)
65 |       (description Resistor)
66 |       (docs ~)
67 |       (footprints
68 |         (fp R_*))
69 |       (fields
70 |         (field (name Reference) R)
71 |         (field (name Value) R))
72 |       (pins
73 |         (pin (num 1) (name ~) (type passive))
74 |         (pin (num 2) (name ~) (type passive)))))
75 |   (libraries
76 |     (library (logical Device)
77 |       (uri "C:\\Program Files\\KiCad\\share\\kicad\\kicad-symbols/Device.lib")))
78 |   (nets
79 |     (net (code 1) (name "Net-(C1-Pad1)")
80 |       (node (ref C1) (pin 1))
81 |       (node (ref D1) (pin 1)))
82 |     (net (code 2) (name "Net-(D1-Pad2)")
83 |       (node (ref D1) (pin 2))
84 |       (node (ref R1) (pin 1)))
85 |     (net (code 3) (name "Net-(C1-Pad2)")
86 |       (node (ref C1) (pin 2))
87 |       (node (ref R1) (pin 2)))))


--------------------------------------------------------------------------------
/tests/kinet2pcb_test/kinet2pcb_test.pro:
--------------------------------------------------------------------------------
 1 | update=12/09/2019 11:01:59 AM
 2 | version=1
 3 | last_client=kicad
 4 | [general]
 5 | version=1
 6 | RootSch=
 7 | BoardNm=
 8 | [pcbnew]
 9 | version=1
10 | LastNetListRead=
11 | UseCmpFile=1
12 | PadDrill=0.600000000000
13 | PadDrillOvalY=0.600000000000
14 | PadSizeH=1.500000000000
15 | PadSizeV=1.500000000000
16 | PcbTextSizeV=1.500000000000
17 | PcbTextSizeH=1.500000000000
18 | PcbTextThickness=0.300000000000
19 | ModuleTextSizeV=1.000000000000
20 | ModuleTextSizeH=1.000000000000
21 | ModuleTextSizeThickness=0.150000000000
22 | SolderMaskClearance=0.000000000000
23 | SolderMaskMinWidth=0.000000000000
24 | DrawSegmentWidth=0.200000000000
25 | BoardOutlineThickness=0.100000000000
26 | ModuleOutlineThickness=0.150000000000
27 | [cvpcb]
28 | version=1
29 | NetIExt=net
30 | [schematic_editor]
31 | version=1
32 | PageLayoutDescrFile=
33 | PlotDirectoryName=
34 | SubpartIdSeparator=0
35 | SubpartFirstId=65
36 | NetFmtName=Pcbnew
37 | SpiceAjustPassiveValues=0
38 | LabSize=50
39 | ERC_TestSimilarLabels=1
40 | [eeschema]
41 | version=1
42 | LibDir=
43 | 


--------------------------------------------------------------------------------
/tests/kinet2pcb_test/kinet2pcb_test.sch:
--------------------------------------------------------------------------------
 1 | EESchema Schematic File Version 4
 2 | LIBS:power
 3 | LIBS:device
 4 | LIBS:transistors
 5 | LIBS:conn
 6 | LIBS:linear
 7 | LIBS:regul
 8 | LIBS:74xx
 9 | LIBS:cmos4000
10 | LIBS:adc-dac
11 | LIBS:memory
12 | LIBS:xilinx
13 | LIBS:microcontrollers
14 | LIBS:dsp
15 | LIBS:microchip
16 | LIBS:analog_switches
17 | LIBS:motorola
18 | LIBS:texas
19 | LIBS:intel
20 | LIBS:audio
21 | LIBS:interface
22 | LIBS:digital-audio
23 | LIBS:philips
24 | LIBS:display
25 | LIBS:cypress
26 | LIBS:siliconi
27 | LIBS:opto
28 | LIBS:atmel
29 | LIBS:contrib
30 | LIBS:valves
31 | EELAYER 30 0
32 | EELAYER END
33 | $Descr A4 11693 8268
34 | encoding utf-8
35 | Sheet 1 1
36 | Title ""
37 | Date ""
38 | Rev ""
39 | Comp ""
40 | Comment1 ""
41 | Comment2 ""
42 | Comment3 ""
43 | Comment4 ""
44 | $EndDescr
45 | $Comp
46 | L Device:C C1
47 | U 1 1 5DBC3998
48 | P 5375 3100
49 | F 0 "C1" H 5490 3146 50  0000 L CNN
50 | F 1 "C" H 5490 3055 50  0000 L CNN
51 | F 2 "Capacitor_SMD:CP_Elec_5x3" H 5413 2950 50  0001 C CNN
52 | F 3 "~" H 5375 3100 50  0001 C CNN
53 | 	1    5375 3100
54 | 	1    0    0    -1  
55 | $EndComp
56 | $Comp
57 | L Device:LED D1
58 | U 1 1 5DBC3E23
59 | P 5375 2600
60 | F 0 "D1" V 5414 2483 50  0000 R CNN
61 | F 1 "LED" V 5323 2483 50  0000 R CNN
62 | F 2 "LED_SMD:LED_0201_0603Metric" H 5375 2600 50  0001 C CNN
63 | F 3 "~" H 5375 2600 50  0001 C CNN
64 | 	1    5375 2600
65 | 	0    -1   -1   0   
66 | $EndComp
67 | $Comp
68 | L Device:R R1
69 | U 1 1 5DBC51E3
70 | P 5025 2825
71 | F 0 "R1" H 5095 2871 50  0000 L CNN
72 | F 1 "R" H 5095 2780 50  0000 L CNN
73 | F 2 "Resistor_SMD:R_0603_1608Metric" V 4955 2825 50  0001 C CNN
74 | F 3 "~" H 5025 2825 50  0001 C CNN
75 | 	1    5025 2825
76 | 	1    0    0    -1  
77 | $EndComp
78 | Wire Wire Line
79 | 	5375 2450 5025 2450
80 | Wire Wire Line
81 | 	5025 2450 5025 2675
82 | Wire Wire Line
83 | 	5025 3375 5375 3375
84 | Wire Wire Line
85 | 	5375 3375 5375 3250
86 | Wire Wire Line
87 | 	5375 2950 5375 2750
88 | Wire Wire Line
89 | 	5025 2975 5025 3375
90 | $EndSCHEMATC
91 | 


--------------------------------------------------------------------------------
/tests/test_kinet2pcb.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | 
 3 | """Tests for `kinet2pcb` package."""
 4 | 
 5 | import pytest
 6 | 
 7 | from kinet2pcb import *
 8 | 
 9 | def test_1():
10 |     """Just test to see if a netlist can be processed without an error."""
11 |     kinet2pcb("kinet2pcb_test/kinet2pcb_test.net", "test_1.kicad_pcb")
12 | 


--------------------------------------------------------------------------------
/tox.ini:
--------------------------------------------------------------------------------
 1 | [tox]
 2 | minversion = 3.15
 3 | envlist = py{36,37,38,39,310,311,312,313}
 4 | skip_missing_interpreters = true
 5 | # The following makes Python 2.7 and 3.6 work.
 6 | requires = virtualenv==20.21
 7 | 
 8 | [testenv:py{36,37,38,39,310,311,312,313}]
 9 | isolated_build = True
10 | passenv = *
11 | extras = testing
12 | deps =
13 |     pytest
14 | changedir = {toxinidir}/tests
15 | commands =
16 |     pip install -e {toxinidir}
17 |     pytest
18 | 
19 | [testenv:{docs}]
20 | description = build the docs
21 | setenv =
22 |     DOCSRC = {toxinidir}/docs
23 | deps =
24 |     ; -r {toxinidir}/docs/requirements.txt
25 |     # ^  requirements.txt shared with Read The Docs
26 |     # This causes doctests to fail. Don't know why.
27 | allowlist_externals =
28 |     python
29 |     make
30 | changedir = {toxinidir}
31 | commands =
32 |     docs: python {toxinidir}/setup.py sdist
33 |     docs: make -C {env:DOCSRC} singlehtml
34 | 


--------------------------------------------------------------------------------