From f168acc1d9dc13e17df36a9c88c013206adf924c Mon Sep 17 00:00:00 2001 From: Stephen Eaton Date: Fri, 26 Feb 2021 15:55:11 +0800 Subject: [PATCH 1/3] restructure --- {{cookiecutter.project_name}}/{docs/.gitkeep => Makefile} | 0 {{cookiecutter.project_name}}/README.md | 1 + {{cookiecutter.project_name}}/{images => output/cad}/.gitkeep | 0 .../{manufacture/bom => output/docs}/.gitkeep | 0 .../{manufacture/gerber => output/docs/bom}/.gitkeep | 0 {{cookiecutter.project_name}}/output/docs/img/.gitkeep | 0 {{cookiecutter.project_name}}/output/gerber/.gitkeep | 0 {{cookiecutter.project_name}}/pipfile | 0 8 files changed, 1 insertion(+) rename {{cookiecutter.project_name}}/{docs/.gitkeep => Makefile} (100%) rename {{cookiecutter.project_name}}/{images => output/cad}/.gitkeep (100%) rename {{cookiecutter.project_name}}/{manufacture/bom => output/docs}/.gitkeep (100%) rename {{cookiecutter.project_name}}/{manufacture/gerber => output/docs/bom}/.gitkeep (100%) create mode 100644 {{cookiecutter.project_name}}/output/docs/img/.gitkeep create mode 100644 {{cookiecutter.project_name}}/output/gerber/.gitkeep create mode 100644 {{cookiecutter.project_name}}/pipfile diff --git a/{{cookiecutter.project_name}}/docs/.gitkeep b/{{cookiecutter.project_name}}/Makefile similarity index 100% rename from {{cookiecutter.project_name}}/docs/.gitkeep rename to {{cookiecutter.project_name}}/Makefile diff --git a/{{cookiecutter.project_name}}/README.md b/{{cookiecutter.project_name}}/README.md index 6711019..19abd1a 100644 --- a/{{cookiecutter.project_name}}/README.md +++ b/{{cookiecutter.project_name}}/README.md @@ -7,6 +7,7 @@ * {{ cookiecutter.project_name}} * A starter KiCad project structured in a manner of + ## Getting Started ## Resources diff --git a/{{cookiecutter.project_name}}/images/.gitkeep b/{{cookiecutter.project_name}}/output/cad/.gitkeep similarity index 100% rename from {{cookiecutter.project_name}}/images/.gitkeep rename to {{cookiecutter.project_name}}/output/cad/.gitkeep diff --git a/{{cookiecutter.project_name}}/manufacture/bom/.gitkeep b/{{cookiecutter.project_name}}/output/docs/.gitkeep similarity index 100% rename from {{cookiecutter.project_name}}/manufacture/bom/.gitkeep rename to {{cookiecutter.project_name}}/output/docs/.gitkeep diff --git a/{{cookiecutter.project_name}}/manufacture/gerber/.gitkeep b/{{cookiecutter.project_name}}/output/docs/bom/.gitkeep similarity index 100% rename from {{cookiecutter.project_name}}/manufacture/gerber/.gitkeep rename to {{cookiecutter.project_name}}/output/docs/bom/.gitkeep diff --git a/{{cookiecutter.project_name}}/output/docs/img/.gitkeep b/{{cookiecutter.project_name}}/output/docs/img/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/{{cookiecutter.project_name}}/output/gerber/.gitkeep b/{{cookiecutter.project_name}}/output/gerber/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/{{cookiecutter.project_name}}/pipfile b/{{cookiecutter.project_name}}/pipfile new file mode 100644 index 0000000..e69de29 From cde10a8b1e5d8ce310bf863a376c73ca07f31dcb Mon Sep 17 00:00:00 2001 From: Stephen Eaton Date: Fri, 26 Feb 2021 18:08:49 +0800 Subject: [PATCH 2/3] start of mkdocs integration --- .gitignore | 1 + {{cookiecutter.project_name}}/.gitignore | 5 +- {{cookiecutter.project_name}}/AUTHORS.rst | 11 + {{cookiecutter.project_name}}/Makefile | 12 + {{cookiecutter.project_name}}/Pipfile.lock | 324 ++++++++++++++++ {{cookiecutter.project_name}}/README.md | 365 ------------------ .../docs/.gitkeep => docs/changelog.md} | 0 .../docs/contributors.md | 1 + {{cookiecutter.project_name}}/docs/index.md | 10 + {{cookiecutter.project_name}}/docs/license.md | 1 + {{cookiecutter.project_name}}/mkdocs.yml | 48 +++ .../output/{docs => }/bom/.gitkeep | 0 .../output/{docs => }/img/.gitkeep | 0 {{cookiecutter.project_name}}/pipfile | 13 + 14 files changed, 425 insertions(+), 366 deletions(-) create mode 100644 .gitignore create mode 100644 {{cookiecutter.project_name}}/AUTHORS.rst create mode 100644 {{cookiecutter.project_name}}/Pipfile.lock rename {{cookiecutter.project_name}}/{output/docs/.gitkeep => docs/changelog.md} (100%) create mode 100644 {{cookiecutter.project_name}}/docs/contributors.md create mode 100644 {{cookiecutter.project_name}}/docs/index.md create mode 100644 {{cookiecutter.project_name}}/docs/license.md create mode 100644 {{cookiecutter.project_name}}/mkdocs.yml rename {{cookiecutter.project_name}}/output/{docs => }/bom/.gitkeep (100%) rename {{cookiecutter.project_name}}/output/{docs => }/img/.gitkeep (100%) diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ccbfadb --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +site/ \ No newline at end of file diff --git a/{{cookiecutter.project_name}}/.gitignore b/{{cookiecutter.project_name}}/.gitignore index ca8b5b3..a3c0905 100644 --- a/{{cookiecutter.project_name}}/.gitignore +++ b/{{cookiecutter.project_name}}/.gitignore @@ -50,4 +50,7 @@ Network Trash Folder Temporary Items .apdisk -# TODO: Add CPP / Arduino ignores \ No newline at end of file +# mkdocs +site/ + +#TODO: Add CPP / Arduino ignores \ No newline at end of file diff --git a/{{cookiecutter.project_name}}/AUTHORS.rst b/{{cookiecutter.project_name}}/AUTHORS.rst new file mode 100644 index 0000000..977a847 --- /dev/null +++ b/{{cookiecutter.project_name}}/AUTHORS.rst @@ -0,0 +1,11 @@ +******* +Authors +******* + +Leads +===== + +- {{ cookiecutter.project_author }} '@{{ cookiecutter.github_user}} ' + +Contributors (chronological) +============================ \ No newline at end of file diff --git a/{{cookiecutter.project_name}}/Makefile b/{{cookiecutter.project_name}}/Makefile index e69de29..6e098c6 100644 --- a/{{cookiecutter.project_name}}/Makefile +++ b/{{cookiecutter.project_name}}/Makefile @@ -0,0 +1,12 @@ + + +.PHONY: serve build install + +install: + pipenv install + +build: + pipenv run mkdocs build + +serve: build + pipenv run mkdocs serve diff --git a/{{cookiecutter.project_name}}/Pipfile.lock b/{{cookiecutter.project_name}}/Pipfile.lock new file mode 100644 index 0000000..b9bb4ee --- /dev/null +++ b/{{cookiecutter.project_name}}/Pipfile.lock @@ -0,0 +1,324 @@ +{ + "_meta": { + "hash": { + "sha256": "18099441497d7ba26eac6ba834092fdb5e6889ebb6afcd5b1eb25045309c574d" + }, + "pipfile-spec": 6, + "requires": { + "python_version": "3.9" + }, + "sources": [ + { + "name": "pypi", + "url": "https://pypi.org/simple", + "verify_ssl": true + } + ] + }, + "default": { + "click": { + "hashes": [ + "sha256:d2b5255c7c6349bc1bd1e59e08cd12acbbd63ce649f2588755783aa94dfb6b1a", + "sha256:dacca89f4bfadd5de3d7489b7c8a566eee0d3676333fbb50030263894c38c0dc" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'", + "version": "==7.1.2" + }, + "future": { + "hashes": [ + "sha256:b1bead90b70cf6ec3f0710ae53a525360fa360d306a86583adc6bf83a4db537d" + ], + "markers": "python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'", + "version": "==0.18.2" + }, + "jinja2": { + "hashes": [ + "sha256:03e47ad063331dd6a3f04a43eddca8a966a26ba0c5b7207a9a9e4e08f1b29419", + "sha256:a6d58433de0ae800347cab1fa3043cebbabe8baa9d29e668f1c768cb87a333c6" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'", + "version": "==2.11.3" + }, + "joblib": { + "hashes": [ + "sha256:9c17567692206d2f3fb9ecf5e991084254fe631665c450b443761c4186a613f7", + "sha256:feeb1ec69c4d45129954f1b7034954241eedfd6ba39b5e9e4b6883be3332d5e5" + ], + "markers": "python_version >= '3.6'", + "version": "==1.0.1" + }, + "livereload": { + "hashes": [ + "sha256:776f2f865e59fde56490a56bcc6773b6917366bce0c267c60ee8aaf1a0959869" + ], + "version": "==2.6.3" + }, + "lunr": { + "extras": [ + "languages" + ], + "hashes": [ + "sha256:aab3f489c4d4fab4c1294a257a30fec397db56f0a50273218ccc3efdbf01d6ca", + "sha256:c4fb063b98eff775dd638b3df380008ae85e6cb1d1a24d1cd81a10ef6391c26e" + ], + "version": "==0.5.8" + }, + "markdown": { + "hashes": [ + "sha256:31b5b491868dcc87d6c24b7e3d19a0d730d59d3e46f4eea6430a321bed387a49", + "sha256:96c3ba1261de2f7547b46a00ea8463832c921d3f9d6aba3f255a6f71386db20c" + ], + "markers": "python_version >= '3.6'", + "version": "==3.3.4" + }, + "markupsafe": { + "hashes": [ + "sha256:00bc623926325b26bb9605ae9eae8a215691f33cae5df11ca5424f06f2d1f473", + "sha256:09027a7803a62ca78792ad89403b1b7a73a01c8cb65909cd876f7fcebd79b161", + "sha256:09c4b7f37d6c648cb13f9230d847adf22f8171b1ccc4d5682398e77f40309235", + "sha256:1027c282dad077d0bae18be6794e6b6b8c91d58ed8a8d89a89d59693b9131db5", + "sha256:13d3144e1e340870b25e7b10b98d779608c02016d5184cfb9927a9f10c689f42", + "sha256:195d7d2c4fbb0ee8139a6cf67194f3973a6b3042d742ebe0a9ed36d8b6f0c07f", + "sha256:22c178a091fc6630d0d045bdb5992d2dfe14e3259760e713c490da5323866c39", + "sha256:24982cc2533820871eba85ba648cd53d8623687ff11cbb805be4ff7b4c971aff", + "sha256:29872e92839765e546828bb7754a68c418d927cd064fd4708fab9fe9c8bb116b", + "sha256:2beec1e0de6924ea551859edb9e7679da6e4870d32cb766240ce17e0a0ba2014", + "sha256:3b8a6499709d29c2e2399569d96719a1b21dcd94410a586a18526b143ec8470f", + "sha256:43a55c2930bbc139570ac2452adf3d70cdbb3cfe5912c71cdce1c2c6bbd9c5d1", + "sha256:46c99d2de99945ec5cb54f23c8cd5689f6d7177305ebff350a58ce5f8de1669e", + "sha256:500d4957e52ddc3351cabf489e79c91c17f6e0899158447047588650b5e69183", + "sha256:535f6fc4d397c1563d08b88e485c3496cf5784e927af890fb3c3aac7f933ec66", + "sha256:596510de112c685489095da617b5bcbbac7dd6384aeebeda4df6025d0256a81b", + "sha256:62fe6c95e3ec8a7fad637b7f3d372c15ec1caa01ab47926cfdf7a75b40e0eac1", + "sha256:6788b695d50a51edb699cb55e35487e430fa21f1ed838122d722e0ff0ac5ba15", + "sha256:6dd73240d2af64df90aa7c4e7481e23825ea70af4b4922f8ede5b9e35f78a3b1", + "sha256:6f1e273a344928347c1290119b493a1f0303c52f5a5eae5f16d74f48c15d4a85", + "sha256:6fffc775d90dcc9aed1b89219549b329a9250d918fd0b8fa8d93d154918422e1", + "sha256:717ba8fe3ae9cc0006d7c451f0bb265ee07739daf76355d06366154ee68d221e", + "sha256:79855e1c5b8da654cf486b830bd42c06e8780cea587384cf6545b7d9ac013a0b", + "sha256:7c1699dfe0cf8ff607dbdcc1e9b9af1755371f92a68f706051cc8c37d447c905", + "sha256:7fed13866cf14bba33e7176717346713881f56d9d2bcebab207f7a036f41b850", + "sha256:84dee80c15f1b560d55bcfe6d47b27d070b4681c699c572af2e3c7cc90a3b8e0", + "sha256:88e5fcfb52ee7b911e8bb6d6aa2fd21fbecc674eadd44118a9cc3863f938e735", + "sha256:8defac2f2ccd6805ebf65f5eeb132adcf2ab57aa11fdf4c0dd5169a004710e7d", + "sha256:98bae9582248d6cf62321dcb52aaf5d9adf0bad3b40582925ef7c7f0ed85fceb", + "sha256:98c7086708b163d425c67c7a91bad6e466bb99d797aa64f965e9d25c12111a5e", + "sha256:9add70b36c5666a2ed02b43b335fe19002ee5235efd4b8a89bfcf9005bebac0d", + "sha256:9bf40443012702a1d2070043cb6291650a0841ece432556f784f004937f0f32c", + "sha256:a6a744282b7718a2a62d2ed9d993cad6f5f585605ad352c11de459f4108df0a1", + "sha256:acf08ac40292838b3cbbb06cfe9b2cb9ec78fce8baca31ddb87aaac2e2dc3bc2", + "sha256:ade5e387d2ad0d7ebf59146cc00c8044acbd863725f887353a10df825fc8ae21", + "sha256:b00c1de48212e4cc9603895652c5c410df699856a2853135b3967591e4beebc2", + "sha256:b1282f8c00509d99fef04d8ba936b156d419be841854fe901d8ae224c59f0be5", + "sha256:b1dba4527182c95a0db8b6060cc98ac49b9e2f5e64320e2b56e47cb2831978c7", + "sha256:b2051432115498d3562c084a49bba65d97cf251f5a331c64a12ee7e04dacc51b", + "sha256:b7d644ddb4dbd407d31ffb699f1d140bc35478da613b441c582aeb7c43838dd8", + "sha256:ba59edeaa2fc6114428f1637ffff42da1e311e29382d81b339c1817d37ec93c6", + "sha256:bf5aa3cbcfdf57fa2ee9cd1822c862ef23037f5c832ad09cfea57fa846dec193", + "sha256:c8716a48d94b06bb3b2524c2b77e055fb313aeb4ea620c8dd03a105574ba704f", + "sha256:caabedc8323f1e93231b52fc32bdcde6db817623d33e100708d9a68e1f53b26b", + "sha256:cd5df75523866410809ca100dc9681e301e3c27567cf498077e8551b6d20e42f", + "sha256:cdb132fc825c38e1aeec2c8aa9338310d29d337bebbd7baa06889d09a60a1fa2", + "sha256:d53bc011414228441014aa71dbec320c66468c1030aae3a6e29778a3382d96e5", + "sha256:d73a845f227b0bfe8a7455ee623525ee656a9e2e749e4742706d80a6065d5e2c", + "sha256:d9be0ba6c527163cbed5e0857c451fcd092ce83947944d6c14bc95441203f032", + "sha256:e249096428b3ae81b08327a63a485ad0878de3fb939049038579ac0ef61e17e7", + "sha256:e8313f01ba26fbbe36c7be1966a7b7424942f670f38e666995b88d012765b9be", + "sha256:feb7b34d6325451ef96bc0e36e1a6c0c1c64bc1fbec4b854f4529e51887b1621" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", + "version": "==1.1.1" + }, + "mkdocs": { + "hashes": [ + "sha256:096f52ff52c02c7e90332d2e53da862fde5c062086e1b5356a6e392d5d60f5e9", + "sha256:f0b61e5402b99d7789efa032c7a74c90a20220a9c81749da06dbfbcbd52ffb39" + ], + "markers": "python_version >= '3.5'", + "version": "==1.1.2" + }, + "mkdocs-material": { + "hashes": [ + "sha256:853b9276a32700fed7fbdf608d6ac39297edcdf8cb683c6337acb412d9c7bb57", + "sha256:cb2ba082f91e6ca8517589cddf31f9f9134cd081aa50c7973895734c8d56f13b" + ], + "index": "pypi", + "version": "==7.0.2" + }, + "mkdocs-material-extensions": { + "hashes": [ + "sha256:6947fb7f5e4291e3c61405bad3539d81e0b3cd62ae0d66ced018128af509c68f", + "sha256:d90c807a88348aa6d1805657ec5c0b2d8d609c110e62b9dce4daf7fa981fa338" + ], + "markers": "python_version >= '3.5'", + "version": "==1.0.1" + }, + "mkdocs-print-site-plugin": { + "hashes": [ + "sha256:b6cc3abe92f5569e943086109b9b04d5ff34669e086dab733c91bcad8efcf528", + "sha256:c1d1fa1ba6e067b1adc2cac93fbdb646f332074161266f9b48c3909e186152ad" + ], + "index": "pypi", + "version": "==1.1.0" + }, + "nltk": { + "hashes": [ + "sha256:845365449cd8c5f9731f7cb9f8bd6fd0767553b9d53af9eb1b3abf7700936b35" + ], + "version": "==3.5" + }, + "pygments": { + "hashes": [ + "sha256:37a13ba168a02ac54cc5891a42b1caec333e59b66addb7fa633ea8a6d73445c0", + "sha256:b21b072d0ccdf29297a82a2363359d99623597b8a265b8081760e4d0f7153c88" + ], + "markers": "python_version >= '3.5'", + "version": "==2.8.0" + }, + "pymdown-extensions": { + "hashes": [ + "sha256:478b2c04513fbb2db61688d5f6e9030a92fb9be14f1f383535c43f7be9dff95b", + "sha256:632371fa3bf1b21a0e3f4063010da59b41db049f261f4c0b0872069a9b6d1735" + ], + "markers": "python_version >= '3.6'", + "version": "==8.1.1" + }, + "pyyaml": { + "hashes": [ + "sha256:08682f6b72c722394747bddaf0aa62277e02557c0fd1c42cb853016a38f8dedf", + "sha256:0f5f5786c0e09baddcd8b4b45f20a7b5d61a7e7e99846e3c799b05c7c53fa696", + "sha256:129def1b7c1bf22faffd67b8f3724645203b79d8f4cc81f674654d9902cb4393", + "sha256:294db365efa064d00b8d1ef65d8ea2c3426ac366c0c4368d930bf1c5fb497f77", + "sha256:3b2b1824fe7112845700f815ff6a489360226a5609b96ec2190a45e62a9fc922", + "sha256:3bd0e463264cf257d1ffd2e40223b197271046d09dadf73a0fe82b9c1fc385a5", + "sha256:4465124ef1b18d9ace298060f4eccc64b0850899ac4ac53294547536533800c8", + "sha256:49d4cdd9065b9b6e206d0595fee27a96b5dd22618e7520c33204a4a3239d5b10", + "sha256:4e0583d24c881e14342eaf4ec5fbc97f934b999a6828693a99157fde912540cc", + "sha256:5accb17103e43963b80e6f837831f38d314a0495500067cb25afab2e8d7a4018", + "sha256:607774cbba28732bfa802b54baa7484215f530991055bb562efbed5b2f20a45e", + "sha256:6c78645d400265a062508ae399b60b8c167bf003db364ecb26dcab2bda048253", + "sha256:74c1485f7707cf707a7aef42ef6322b8f97921bd89be2ab6317fd782c2d53183", + "sha256:8c1be557ee92a20f184922c7b6424e8ab6691788e6d86137c5d93c1a6ec1b8fb", + "sha256:bb4191dfc9306777bc594117aee052446b3fa88737cd13b7188d0e7aa8162185", + "sha256:c20cfa2d49991c8b4147af39859b167664f2ad4561704ee74c1de03318e898db", + "sha256:d2d9808ea7b4af864f35ea216be506ecec180628aced0704e34aca0b040ffe46", + "sha256:dd5de0646207f053eb0d6c74ae45ba98c3395a571a2891858e87df7c9b9bd51b", + "sha256:e1d4970ea66be07ae37a3c2e48b5ec63f7ba6804bdddfdbd3cfd954d25a82e63", + "sha256:e4fac90784481d221a8e4b1162afa7c47ed953be40d31ab4629ae917510051df", + "sha256:fa5ae20527d8e831e8230cbffd9f8fe952815b2b7dae6ffec25318803a7528fc" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4, 3.5'", + "version": "==5.4.1" + }, + "regex": { + "hashes": [ + "sha256:02951b7dacb123d8ea6da44fe45ddd084aa6777d4b2454fa0da61d569c6fa538", + "sha256:0d08e71e70c0237883d0bef12cad5145b84c3705e9c6a588b2a9c7080e5af2a4", + "sha256:1862a9d9194fae76a7aaf0150d5f2a8ec1da89e8b55890b1786b8f88a0f619dc", + "sha256:1ab79fcb02b930de09c76d024d279686ec5d532eb814fd0ed1e0051eb8bd2daa", + "sha256:1fa7ee9c2a0e30405e21031d07d7ba8617bc590d391adfc2b7f1e8b99f46f444", + "sha256:262c6825b309e6485ec2493ffc7e62a13cf13fb2a8b6d212f72bd53ad34118f1", + "sha256:2a11a3e90bd9901d70a5b31d7dd85114755a581a5da3fc996abfefa48aee78af", + "sha256:2c99e97d388cd0a8d30f7c514d67887d8021541b875baf09791a3baad48bb4f8", + "sha256:3128e30d83f2e70b0bed9b2a34e92707d0877e460b402faca908c6667092ada9", + "sha256:38c8fd190db64f513fe4e1baa59fed086ae71fa45083b6936b52d34df8f86a88", + "sha256:3bddc701bdd1efa0d5264d2649588cbfda549b2899dc8d50417e47a82e1387ba", + "sha256:4902e6aa086cbb224241adbc2f06235927d5cdacffb2425c73e6570e8d862364", + "sha256:49cae022fa13f09be91b2c880e58e14b6da5d10639ed45ca69b85faf039f7a4e", + "sha256:56e01daca75eae420bce184edd8bb341c8eebb19dd3bce7266332258f9fb9dd7", + "sha256:5862975b45d451b6db51c2e654990c1820523a5b07100fc6903e9c86575202a0", + "sha256:6a8ce43923c518c24a2579fda49f093f1397dad5d18346211e46f134fc624e31", + "sha256:6c54ce4b5d61a7129bad5c5dc279e222afd00e721bf92f9ef09e4fae28755683", + "sha256:6e4b08c6f8daca7d8f07c8d24e4331ae7953333dbd09c648ed6ebd24db5a10ee", + "sha256:717881211f46de3ab130b58ec0908267961fadc06e44f974466d1887f865bd5b", + "sha256:749078d1eb89484db5f34b4012092ad14b327944ee7f1c4f74d6279a6e4d1884", + "sha256:7913bd25f4ab274ba37bc97ad0e21c31004224ccb02765ad984eef43e04acc6c", + "sha256:7a25fcbeae08f96a754b45bdc050e1fb94b95cab046bf56b016c25e9ab127b3e", + "sha256:83d6b356e116ca119db8e7c6fc2983289d87b27b3fac238cfe5dca529d884562", + "sha256:8b882a78c320478b12ff024e81dc7d43c1462aa4a3341c754ee65d857a521f85", + "sha256:8f6a2229e8ad946e36815f2a03386bb8353d4bde368fdf8ca5f0cb97264d3b5c", + "sha256:9801c4c1d9ae6a70aeb2128e5b4b68c45d4f0af0d1535500884d644fa9b768c6", + "sha256:a15f64ae3a027b64496a71ab1f722355e570c3fac5ba2801cafce846bf5af01d", + "sha256:a3d748383762e56337c39ab35c6ed4deb88df5326f97a38946ddd19028ecce6b", + "sha256:a63f1a07932c9686d2d416fb295ec2c01ab246e89b4d58e5fa468089cab44b70", + "sha256:b2b1a5ddae3677d89b686e5c625fc5547c6e492bd755b520de5332773a8af06b", + "sha256:b2f4007bff007c96a173e24dcda236e5e83bde4358a557f9ccf5e014439eae4b", + "sha256:baf378ba6151f6e272824b86a774326f692bc2ef4cc5ce8d5bc76e38c813a55f", + "sha256:bafb01b4688833e099d79e7efd23f99172f501a15c44f21ea2118681473fdba0", + "sha256:bba349276b126947b014e50ab3316c027cac1495992f10e5682dc677b3dfa0c5", + "sha256:c084582d4215593f2f1d28b65d2a2f3aceff8342aa85afd7be23a9cad74a0de5", + "sha256:d1ebb090a426db66dd80df8ca85adc4abfcbad8a7c2e9a5ec7513ede522e0a8f", + "sha256:d2d8ce12b7c12c87e41123997ebaf1a5767a5be3ec545f64675388970f415e2e", + "sha256:e32f5f3d1b1c663af7f9c4c1e72e6ffe9a78c03a31e149259f531e0fed826512", + "sha256:e3faaf10a0d1e8e23a9b51d1900b72e1635c2d5b0e1bea1c18022486a8e2e52d", + "sha256:f7d29a6fc4760300f86ae329e3b6ca28ea9c20823df123a2ea8693e967b29917", + "sha256:f8f295db00ef5f8bae530fc39af0b40486ca6068733fb860b42115052206466f" + ], + "version": "==2020.11.13" + }, + "six": { + "hashes": [ + "sha256:30639c035cdb23534cd4aa2dd52c3bf48f06e5f4a941509c8bafd8ce11080259", + "sha256:8b74bedcbbbaca38ff6d7491d76f2b06b3592611af620f8426e82dddb04a5ced" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", + "version": "==1.15.0" + }, + "tornado": { + "hashes": [ + "sha256:0a00ff4561e2929a2c37ce706cb8233b7907e0cdc22eab98888aca5dd3775feb", + "sha256:0d321a39c36e5f2c4ff12b4ed58d41390460f798422c4504e09eb5678e09998c", + "sha256:1e8225a1070cd8eec59a996c43229fe8f95689cb16e552d130b9793cb570a288", + "sha256:20241b3cb4f425e971cb0a8e4ffc9b0a861530ae3c52f2b0434e6c1b57e9fd95", + "sha256:25ad220258349a12ae87ede08a7b04aca51237721f63b1808d39bdb4b2164558", + "sha256:33892118b165401f291070100d6d09359ca74addda679b60390b09f8ef325ffe", + "sha256:33c6e81d7bd55b468d2e793517c909b139960b6c790a60b7991b9b6b76fb9791", + "sha256:3447475585bae2e77ecb832fc0300c3695516a47d46cefa0528181a34c5b9d3d", + "sha256:34ca2dac9e4d7afb0bed4677512e36a52f09caa6fded70b4e3e1c89dbd92c326", + "sha256:3e63498f680547ed24d2c71e6497f24bca791aca2fe116dbc2bd0ac7f191691b", + "sha256:548430be2740e327b3fe0201abe471f314741efcb0067ec4f2d7dcfb4825f3e4", + "sha256:6196a5c39286cc37c024cd78834fb9345e464525d8991c21e908cc046d1cc02c", + "sha256:61b32d06ae8a036a6607805e6720ef00a3c98207038444ba7fd3d169cd998910", + "sha256:6286efab1ed6e74b7028327365cf7346b1d777d63ab30e21a0f4d5b275fc17d5", + "sha256:65d98939f1a2e74b58839f8c4dab3b6b3c1ce84972ae712be02845e65391ac7c", + "sha256:66324e4e1beede9ac79e60f88de548da58b1f8ab4b2f1354d8375774f997e6c0", + "sha256:6c77c9937962577a6a76917845d06af6ab9197702a42e1346d8ae2e76b5e3675", + "sha256:70dec29e8ac485dbf57481baee40781c63e381bebea080991893cd297742b8fd", + "sha256:7250a3fa399f08ec9cb3f7b1b987955d17e044f1ade821b32e5f435130250d7f", + "sha256:748290bf9112b581c525e6e6d3820621ff020ed95af6f17fedef416b27ed564c", + "sha256:7da13da6f985aab7f6f28debab00c67ff9cbacd588e8477034c0652ac141feea", + "sha256:8f959b26f2634a091bb42241c3ed8d3cedb506e7c27b8dd5c7b9f745318ddbb6", + "sha256:9de9e5188a782be6b1ce866e8a51bc76a0fbaa0e16613823fc38e4fc2556ad05", + "sha256:a48900ecea1cbb71b8c71c620dee15b62f85f7c14189bdeee54966fbd9a0c5bd", + "sha256:b87936fd2c317b6ee08a5741ea06b9d11a6074ef4cc42e031bc6403f82a32575", + "sha256:c77da1263aa361938476f04c4b6c8916001b90b2c2fdd92d8d535e1af48fba5a", + "sha256:cb5ec8eead331e3bb4ce8066cf06d2dfef1bfb1b2a73082dfe8a161301b76e37", + "sha256:cc0ee35043162abbf717b7df924597ade8e5395e7b66d18270116f8745ceb795", + "sha256:d14d30e7f46a0476efb0deb5b61343b1526f73ebb5ed84f23dc794bdb88f9d9f", + "sha256:d371e811d6b156d82aa5f9a4e08b58debf97c302a35714f6f45e35139c332e32", + "sha256:d3d20ea5782ba63ed13bc2b8c291a053c8d807a8fa927d941bd718468f7b950c", + "sha256:d3f7594930c423fd9f5d1a76bee85a2c36fd8b4b16921cae7e965f22575e9c01", + "sha256:dcef026f608f678c118779cd6591c8af6e9b4155c44e0d1bc0c87c036fb8c8c4", + "sha256:e0791ac58d91ac58f694d8d2957884df8e4e2f6687cdf367ef7eb7497f79eaa2", + "sha256:e385b637ac3acaae8022e7e47dfa7b83d3620e432e3ecb9a3f7f58f150e50921", + "sha256:e519d64089b0876c7b467274468709dadf11e41d65f63bba207e04217f47c085", + "sha256:e7229e60ac41a1202444497ddde70a48d33909e484f96eb0da9baf8dc68541df", + "sha256:ed3ad863b1b40cd1d4bd21e7498329ccaece75db5a5bf58cd3c9f130843e7102", + "sha256:f0ba29bafd8e7e22920567ce0d232c26d4d47c8b5cf4ed7b562b5db39fa199c5", + "sha256:fa2ba70284fa42c2a5ecb35e322e68823288a4251f9ba9cc77be04ae15eada68", + "sha256:fba85b6cd9c39be262fcd23865652920832b61583de2a2ca907dbd8e8a8c81e5" + ], + "markers": "python_version >= '3.5'", + "version": "==6.1" + }, + "tqdm": { + "hashes": [ + "sha256:2c44efa73b8914dba7807aefd09653ac63c22b5b4ea34f7a80973f418f1a3089", + "sha256:c23ac707e8e8aabb825e4d91f8e17247f9cc14b0d64dd9e97be0781e9e525bba" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", + "version": "==4.58.0" + } + }, + "develop": {} +} diff --git a/{{cookiecutter.project_name}}/README.md b/{{cookiecutter.project_name}}/README.md index 19abd1a..3733702 100644 --- a/{{cookiecutter.project_name}}/README.md +++ b/{{cookiecutter.project_name}}/README.md @@ -22,368 +22,3 @@ Below are some handy resource links. * **{{ cookiecutter.author_name }}** - *Initial Work* - [github](https://github.com/{{cookiecutter.github_user}}) See also the list of [contributors](https://github.com/{{cookiecutter.github_user}}/{{cookiecutter.project_github_repo_name}}/contributors) who participated in this project. - -## License - -{%- if cookiecutter.license == "MIT" -%} -MIT License - -Copyright (c) {% now 'utc', '%Y' %}, {{cookiecutter.author_name}} - -Permission is hereby granted, free of charge, to any person obtaining a copy of this hardware, software, and associated documentation files (the "Product"), to deal in the Product without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Product, and to permit persons to whom the Product is furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Product. - -THE PRODUCT IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE PRODUCT OR THE USE OR OTHER DEALINGS IN THE PRODUCT. - -{%- elif cookiecutter.license == "CC-A-SA" -%} -Creative Commons Attribution Share A like License - -This is a human-readable summary of the full license below. - -You are free: -* **to Share**—to copy, distribute and transmit the work, and -* **to Remix**—to adapt the work - -Under the following conditions -* **Attribution**—You must attribute the work in the manner specified by the author or licensor (but not in any way that suggests that they endorse you or your use of the work.) -* **Share Alike**—If you alter, transform, or build upon this work, you may distribute the resulting work only under the same, similar or a compatible license. - -With the understanding that: -* **Waiver** — Any of the above conditions can be waived if you get permission from the copyright holder. -* **Other Rights** — In no way are any of the following rights affected by the license: - * your fair dealing or fair use rights; - * the author's moral rights; and - * rights other persons may have either in the work itself or in how the work is used, such as publicity or privacy rights. -* **Notice**—For any reuse or distribution, you must make clear to others the license terms of this work. The best way to do that is with a link to - -{%- elif cookiecutter.license == "CC-A" -%} -Creative Commons Attribution License - -You are free: -* **to Share**—to copy, distribute and transmit the work, and -* **to Remix**—to adapt the work - -Under the following conditions: -* **Attribution**—You must attribute the work in the manner specified by the author or licensor (but not in any way that suggests that they endorse you or your use of the work.) - -With the understanding that: -* **Waiver—Any** of the above conditions can be waived if you get permission from the copyright holder. -* **Other Rights**—In no way are any of the following rights affected by the license: - * your fair dealing or fair use rights; - * the author's moral rights; and - * rights other persons may have either in the work itself or in how the work is used, such as publicity or privacy rights. -* **Notice**—For any reuse or distribution, you must make clear to others the license terms of this work. The best way to do that is with a link to - -{%- elif cookiecutter.license == "TAPR" -%} -TAPR Open Hardware License (OHL) - -Visit the TAPR website for the [full text of the TAPR Open Hardware License (OHL)](http://www.tapr.org/ohl.html). The numbered sections of the agreement take precedence over this preamble. - -* You may modify the documentation and make products based upon it. -* You may use products for any legal purpose without limitation. -* You may distribute unmodified documentation, but you must include the complete package as you received it. -* You may distribute products you make to third parties, if you either include the documentation on which the product is based, or make it available without charge for at least three years to anyone who requests it. - -You may distribute modified documentation or products based on it, if you: - * License your modifications under the OHL. - * Include those modifications, following the requirements stated below. - * Attempt to send the modified documentation by email to any of the developers who have provided their email address. This is a good faith obligation -- if the email fails, you need do nothing more and may go on with your distribution. - -If you create a design that you want to license under the OHL, you should: - * Include the OHL document in a file named LICENSE.TXT (or LICENSE.PDF) that is included in the documentation package. - * If the file format allows, include a notice like "Licensed under the TAPR Open Hardware License ()" in each documentation file. While not required, you should also include this notice on printed circuit board artwork and the product itself; if space is limited the notice can be shortened or abbreviated. - * Include a copyright notice in each file and on printed circuit board artwork. - -If you wish to be notified of modifications that others may make, include your email address in a file named "CONTRIB.TXT" or something similar. - -Any time the OHL requires you to make documentation available to others, you must include all the materials you received from the upstream licensors. In addition, if you have modified the documentation: - * You must identify the modifications in a text file (preferably named "CHANGES.TXT") that you include with the documentation. That file must also include a statement like "These modifications are licensed under the TAPR Open Hardware License." - * You must include any new files you created, including any manufacturing files (such as Gerber files) you create in the course of making products. - * You must include both "before" and "after" versions of all files you modified. - * You may include files in proprietary formats, but you must also include open format versions (such as Gerber, ASCII, Postscript, or PDF) if your tools can create them. - -{%- elif cookiecutter.license == "BSD" -%} - -BSD License - -Copyright (c) {% now 'utc', '%Y' %}, {{cookiecutter.github_user}}. All rights reserved. - -Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - - * Redistributions of product specifications, source code, and documentation must retain the above copyright notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. - -THIS PRODUCT IS PROVIDED BY **{{cookiecutter.author_name}}** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL **{{cookiecutter.author_name}}** OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS PRODUCT, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -The views and conclusions contained in the hardware, software, and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of **{{cookiecutter.author_name}}**. - -{%- elif cookiecutter.license == "OSHD" -%} - -**Introduction** -Open Source Hardware Definition v1.0 - -Open Source Hardware (OSHW) is a term for tangible artifacts -- machines, devices, or other physical things -- whose design has been released to the public in such a way that anyone can make, modify, distribute, and use those things. This definition is intended to help provide guidelines for the development and evaluation of licenses for Open Source Hardware. - -Hardware is different from software in that physical resources must always be committed for the creation of physical goods. Accordingly, persons or companies producing items ("products") under an OSHW license have an obligation to make it clear that such products are not manufactured, sold, warrantied, or otherwise sanctioned by the original designer and also not to make use of any trademarks owned by the original designer. - -The distribution terms of Open Source Hardware must comply with the following criteria: - -1. **Documentation** - -The hardware must be released with documentation including design files, and must allow modification and distribution of the design files. Where documentation is not furnished with the physical product, there must be a well-publicized means of obtaining this documentation for no more than a reasonable reproduction cost, preferably downloading via the Internet without charge. The documentation must include design files in the preferred format for making changes, for example the native file format of a CAD program. Deliberately obfuscated design files are not allowed. Intermediate forms analogous to compiled computer code -- such as printer-ready copper artwork from a CAD program -- are not allowed as substitutes. The license may require that the design files are provided in fully-documented, open format(s). - -2. **Scope** - -The documentation for the hardware must clearly specify what portion of the design, if not all, is being released under the license. - -3. **Necessary Software** - -If the licensed design requires software, embedded or otherwise, to operate properly and fulfill its essential functions, then the license may require that one of the following conditions are met: - -a) The interfaces are sufficiently documented such that it could reasonably be considered straightforward to write open source software that allows the device to operate properly and fulfill its essential functions. For example, this may include the use of detailed signal timing diagrams or pseudocode to clearly illustrate the interface in operation. - -b) The necessary software is released under an OSI-approved open source license. - -4. **Derived Works** - -The license shall allow modifications and derived works, and shall allow them to be distributed under the same terms as the license of the original work. The license shall allow for the manufacture, sale, distribution, and use of products created from the design files, the design files themselves, and derivatives thereof. - -5. **Free redistribution** - -The license shall not restrict any party from selling or giving away the project documentation. The license shall not require a royalty or other fee for such sale. The license shall not require any royalty or fee related to the sale of derived works. - -6. **Attribution** - -The license may require derived documents, and copyright notices associated with devices, to provide attribution to the licensors when distributing design files, manufactured products, and/or derivatives thereof. The license may require that this information be accessible to the end-user using the device normally, but shall not specify a specific format of display. The license may require derived works to carry a different name or version number from the original design. - -7. **No Discrimination Against Persons or Groups** - -The license must not discriminate against any person or group of persons. - -8. **No Discrimination Against Fields of Endeavor** - -The license must not restrict anyone from making use of the work (including manufactured hardware) in a specific field of endeavor. For example, it must not restrict the hardware from being used in a business, or from being used in nuclear research. - -9. **Distribution of License** - -The rights granted by the license must apply to all to whom the work is redistributed without the need for execution of an additional license by those parties. - -10. **License Must Not Be Specific to a Product** - -The rights granted by the license must not depend on the licensed work being part of a particular product. If a portion is extracted from a work and used or distributed within the terms of the license, all parties to whom that work is redistributed should have the same rights as those that are granted for the original work. - -11. **License Must Not Restrict Other Hardware or Software** - -The license must not place restrictions on other items that are aggregated with the licensed work but not derivative of it. For example, the license must not insist that all other hardware sold with the licensed item be open source, nor that only open source software be used external to the device. - -12. **License Must Be Technology-Neutral** - -No provision of the license may be predicated on any individual technology, specific part or component, material, or style of interface or use thereof. - -{%- elif cookiecutter.license == "CERN-OHL-P" -%} -CERN Open Hardware Licence Version 2 - Permissive - - -Preamble - -CERN has developed this licence to promote collaboration among -hardware designers and to provide a legal tool which supports the -freedom to use, study, modify, share and distribute hardware designs -and products based on those designs. Version 2 of the CERN Open -Hardware Licence comes in three variants: this licence, CERN-OHL-P -(permissive); and two reciprocal licences: CERN-OHL-W (weakly -reciprocal) and CERN-OHL-S (strongly reciprocal). - -The CERN-OHL-P is copyright CERN 2020. Anyone is welcome to use it, in -unmodified form only. - -Use of this Licence does not imply any endorsement by CERN of any -Licensor or their designs nor does it imply any involvement by CERN in -their development. - - -1 Definitions - - 1.1 'Licence' means this CERN-OHL-P. - - 1.2 'Source' means information such as design materials or digital - code which can be applied to Make or test a Product or to - prepare a Product for use, Conveyance or sale, regardless of its - medium or how it is expressed. It may include Notices. - - 1.3 'Covered Source' means Source that is explicitly made available - under this Licence. - - 1.4 'Product' means any device, component, work or physical object, - whether in finished or intermediate form, arising from the use, - application or processing of Covered Source. - - 1.5 'Make' means to create or configure something, whether by - manufacture, assembly, compiling, loading or applying Covered - Source or another Product or otherwise. - - 1.6 'Notice' means copyright, acknowledgement and trademark notices, - references to the location of any Notices, modification notices - (subsection 3.3(b)) and all notices that refer to this Licence - and to the disclaimer of warranties that are included in the - Covered Source. - - 1.7 'Licensee' or 'You' means any person exercising rights under - this Licence. - - 1.8 'Licensor' means a person who creates Source or modifies Covered - Source and subsequently Conveys the resulting Covered Source - under the terms and conditions of this Licence. A person may be - a Licensee and a Licensor at the same time. - - 1.9 'Convey' means to communicate to the public or distribute. - - -2 Applicability - - 2.1 This Licence governs the use, copying, modification, Conveying - of Covered Source and Products, and the Making of Products. By - exercising any right granted under this Licence, You irrevocably - accept these terms and conditions. - - 2.2 This Licence is granted by the Licensor directly to You, and - shall apply worldwide and without limitation in time. - - 2.3 You shall not attempt to restrict by contract or otherwise the - rights granted under this Licence to other Licensees. - - 2.4 This Licence is not intended to restrict fair use, fair dealing, - or any other similar right. - - -3 Copying, Modifying and Conveying Covered Source - - 3.1 You may copy and Convey verbatim copies of Covered Source, in - any medium, provided You retain all Notices. - - 3.2 You may modify Covered Source, other than Notices. - - You may only delete Notices if they are no longer applicable to - the corresponding Covered Source as modified by You and You may - add additional Notices applicable to Your modifications. - - 3.3 You may Convey modified Covered Source (with the effect that You - shall also become a Licensor) provided that You: - - a) retain Notices as required in subsection 3.2; and - - b) add a Notice to the modified Covered Source stating that You - have modified it, with the date and brief description of how - You have modified it. - - 3.4 You may Convey Covered Source or modified Covered Source under - licence terms which differ from the terms of this Licence - provided that You: - - a) comply at all times with subsection 3.3; and - - b) provide a copy of this Licence to anyone to whom You - Convey Covered Source or modified Covered Source. - - -4 Making and Conveying Products - -You may Make Products, and/or Convey them, provided that You ensure -that the recipient of the Product has access to any Notices applicable -to the Product. - - -5 DISCLAIMER AND LIABILITY - - 5.1 DISCLAIMER OF WARRANTY -- The Covered Source and any Products - are provided 'as is' and any express or implied warranties, - including, but not limited to, implied warranties of - merchantability, of satisfactory quality, non-infringement of - third party rights, and fitness for a particular purpose or use - are disclaimed in respect of any Source or Product to the - maximum extent permitted by law. The Licensor makes no - representation that any Source or Product does not or will not - infringe any patent, copyright, trade secret or other - proprietary right. The entire risk as to the use, quality, and - performance of any Source or Product shall be with You and not - the Licensor. This disclaimer of warranty is an essential part - of this Licence and a condition for the grant of any rights - granted under this Licence. - - 5.2 EXCLUSION AND LIMITATION OF LIABILITY -- The Licensor shall, to - the maximum extent permitted by law, have no liability for - direct, indirect, special, incidental, consequential, exemplary, - punitive or other damages of any character including, without - limitation, procurement of substitute goods or services, loss of - use, data or profits, or business interruption, however caused - and on any theory of contract, warranty, tort (including - negligence), product liability or otherwise, arising in any way - in relation to the Covered Source, modified Covered Source - and/or the Making or Conveyance of a Product, even if advised of - the possibility of such damages, and You shall hold the - Licensor(s) free and harmless from any liability, costs, - damages, fees and expenses, including claims by third parties, - in relation to such use. - - -6 Patents - - 6.1 Subject to the terms and conditions of this Licence, each - Licensor hereby grants to You a perpetual, worldwide, - non-exclusive, no-charge, royalty-free, irrevocable (except as - stated in this section 6, or where terminated by the Licensor - for cause) patent licence to Make, have Made, use, offer to - sell, sell, import, and otherwise transfer the Covered Source - and Products, where such licence applies only to those patent - claims licensable by such Licensor that are necessarily - infringed by exercising rights under the Covered Source as - Conveyed by that Licensor. - - 6.2 If You institute patent litigation against any entity (including - a cross-claim or counterclaim in a lawsuit) alleging that the - Covered Source or a Product constitutes direct or contributory - patent infringement, or You seek any declaration that a patent - licensed to You under this Licence is invalid or unenforceable - then any rights granted to You under this Licence shall - terminate as of the date such process is initiated. - - -7 General - - 7.1 If any provisions of this Licence are or subsequently become - invalid or unenforceable for any reason, the remaining - provisions shall remain effective. - - 7.2 You shall not use any of the name (including acronyms and - abbreviations), image, or logo by which the Licensor or CERN is - known, except where needed to comply with section 3, or where - the use is otherwise allowed by law. Any such permitted use - shall be factual and shall not be made so as to suggest any kind - of endorsement or implication of involvement by the Licensor or - its personnel. - - 7.3 CERN may publish updated versions and variants of this Licence - which it considers to be in the spirit of this version, but may - differ in detail to address new problems or concerns. New - versions will be published with a unique version number and a - variant identifier specifying the variant. If the Licensor has - specified that a given variant applies to the Covered Source - without specifying a version, You may treat that Covered Source - as being released under any version of the CERN-OHL with that - variant. If no variant is specified, the Covered Source shall be - treated as being released under CERN-OHL-S. The Licensor may - also specify that the Covered Source is subject to a specific - version of the CERN-OHL or any later version in which case You - may apply this or any later version of CERN-OHL with the same - variant identifier published by CERN. - - 7.4 This Licence shall not be enforceable except by a Licensor - acting as such, and third party beneficiary rights are - specifically excluded. - -{%- else -%} -Copyright (c) {% now 'utc', '%Y' %}, {{cookiecutter.author_name}} - -All rights reserved. -{%- endif -%} \ No newline at end of file diff --git a/{{cookiecutter.project_name}}/output/docs/.gitkeep b/{{cookiecutter.project_name}}/docs/changelog.md similarity index 100% rename from {{cookiecutter.project_name}}/output/docs/.gitkeep rename to {{cookiecutter.project_name}}/docs/changelog.md diff --git a/{{cookiecutter.project_name}}/docs/contributors.md b/{{cookiecutter.project_name}}/docs/contributors.md new file mode 100644 index 0000000..5732d11 --- /dev/null +++ b/{{cookiecutter.project_name}}/docs/contributors.md @@ -0,0 +1 @@ +--8<-- "./AUTHORS.rst" \ No newline at end of file diff --git a/{{cookiecutter.project_name}}/docs/index.md b/{{cookiecutter.project_name}}/docs/index.md new file mode 100644 index 0000000..a69edf0 --- /dev/null +++ b/{{cookiecutter.project_name}}/docs/index.md @@ -0,0 +1,10 @@ +# Welcome to {{ cookiecutter.project_name }} + +{{ cookiecutter.project_description }} + +--8<-- "./README.md" + + mkdocs.yml # The configuration file. + docs/ + index.md # The documentation homepage. + ... # Other markdown pages, images and other files. diff --git a/{{cookiecutter.project_name}}/docs/license.md b/{{cookiecutter.project_name}}/docs/license.md new file mode 100644 index 0000000..160fd8e --- /dev/null +++ b/{{cookiecutter.project_name}}/docs/license.md @@ -0,0 +1 @@ +--8<-- "./LICENSE" diff --git a/{{cookiecutter.project_name}}/mkdocs.yml b/{{cookiecutter.project_name}}/mkdocs.yml new file mode 100644 index 0000000..2283372 --- /dev/null +++ b/{{cookiecutter.project_name}}/mkdocs.yml @@ -0,0 +1,48 @@ +# project information +site_name: "{{cookiecutter.project_name}}" +site_author: "{{cookiecutter.project_author}}" +site_description: "{{cookiecutter.project_description}}" + +# Configuration +theme: + name: material + features: + - navigation.tabs + - header.autohide + +# Repository +repo_name: "{{cookiecutter.github_user}}/{{cookiecutter.project_github_repo_name}}" +repo_url: https://github.com/{{cookiecutter.github_user}}/{{cookiecutter.project_github_repo_name}} + +# plugins +plugins: + - search + - print-site # <- needs to be last plugin + +# extensions +markdown_extensions: + - abbr + - admonition + - pymdownx.details + - pymdownx.snippets + - pymdownx.superfences + +# Copyright +copyright: Copyright © 2021 {{cookiecutter.project_author}} + +# footer customisation +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/{{cookiecutter.github_user}}/{{cookiecutter.project_github_repo_name}} + +# Page Tree +nav: + - Home: index.md + - Change Log: changelog.md + - Contributors: contributors.md + - License: license.md +# Google Analytics +#google_analytics: +# - !!python/object/apply:os.getenv ["GOOGLE_ANALYTICS_KEY"] +# - auto diff --git a/{{cookiecutter.project_name}}/output/docs/bom/.gitkeep b/{{cookiecutter.project_name}}/output/bom/.gitkeep similarity index 100% rename from {{cookiecutter.project_name}}/output/docs/bom/.gitkeep rename to {{cookiecutter.project_name}}/output/bom/.gitkeep diff --git a/{{cookiecutter.project_name}}/output/docs/img/.gitkeep b/{{cookiecutter.project_name}}/output/img/.gitkeep similarity index 100% rename from {{cookiecutter.project_name}}/output/docs/img/.gitkeep rename to {{cookiecutter.project_name}}/output/img/.gitkeep diff --git a/{{cookiecutter.project_name}}/pipfile b/{{cookiecutter.project_name}}/pipfile index e69de29..a73ebc0 100644 --- a/{{cookiecutter.project_name}}/pipfile +++ b/{{cookiecutter.project_name}}/pipfile @@ -0,0 +1,13 @@ +[[source]] +url = "https://pypi.org/simple" +verify_ssl = true +name = "pypi" + +[packages] +mkdocs-material = "*" +mkdocs-print-site-plugin = "*" + +[dev-packages] + +[requires] +python_version = "3.9" From 83e32f78e505a6cd7a96664eaf76510245f44ec3 Mon Sep 17 00:00:00 2001 From: Stephen Eaton Date: Mon, 1 Mar 2021 11:12:45 +0800 Subject: [PATCH 3/3] Started project documentaiton, added docs to template --- .github/workflow/publish-docs.yml | 20 + CHANGELOG.md | 9 + CONTRIBUTORS.md | 8 + Makefile | 12 + Pipfile | 14 + Pipfile.lock | 353 ++++++++++++++++++ README.md | 4 +- docs/changelog.md | 4 + docs/contributors.md | 4 + docs/index.md | 7 + docs/license.md | 3 + mkdocs.yml | 68 ++++ {{cookiecutter.project_name}}/AUTHORS.rst | 2 +- {{cookiecutter.project_name}}/Pipfile.lock | 31 +- {{cookiecutter.project_name}}/README.md | 2 +- .../docs/contributors.md | 3 + .../docs/firmware.md | 2 + .../docs/hardware.md | 3 + {{cookiecutter.project_name}}/docs/license.md | 2 + {{cookiecutter.project_name}}/mkdocs.yml | 34 +- {{cookiecutter.project_name}}/pipfile | 1 + 21 files changed, 578 insertions(+), 8 deletions(-) create mode 100644 .github/workflow/publish-docs.yml create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTORS.md create mode 100644 Makefile create mode 100644 Pipfile create mode 100644 Pipfile.lock create mode 100644 docs/changelog.md create mode 100644 docs/contributors.md create mode 100644 docs/index.md create mode 100644 docs/license.md create mode 100644 mkdocs.yml create mode 100644 {{cookiecutter.project_name}}/docs/firmware.md create mode 100644 {{cookiecutter.project_name}}/docs/hardware.md diff --git a/.github/workflow/publish-docs.yml b/.github/workflow/publish-docs.yml new file mode 100644 index 0000000..c6be2c8 --- /dev/null +++ b/.github/workflow/publish-docs.yml @@ -0,0 +1,20 @@ +name: Publish docs via GitHub Pages +on: + push: + branches: [master] + pull_request: + branches: [master] +jobs: + build: + name: Deploy docs + runs-on: ubuntu-latest + steps: + - name: Checkout main + uses: actions/checkout@v2 + + - name: Deploy docs + uses: mhausenblas/mkdocs-deploy-gh-pages@master + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + CONFIG_FILE: folder/mkdocs.yml + EXTRA_PACKAGES: build-base diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..60a2dde --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,9 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) +and this project adheres to [Calendar Versioning](https://calver.org/). + +## [Unreleased] +- Added documentation to project +- Added documentation to template diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md new file mode 100644 index 0000000..04a8941 --- /dev/null +++ b/CONTRIBUTORS.md @@ -0,0 +1,8 @@ + +Leads +===== + +- Stephen Eaton '@madeinoz67 ' + +Contributors (chronological) +============================ diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..6e098c6 --- /dev/null +++ b/Makefile @@ -0,0 +1,12 @@ + + +.PHONY: serve build install + +install: + pipenv install + +build: + pipenv run mkdocs build + +serve: build + pipenv run mkdocs serve diff --git a/Pipfile b/Pipfile new file mode 100644 index 0000000..95100f1 --- /dev/null +++ b/Pipfile @@ -0,0 +1,14 @@ +[[source]] +url = "https://pypi.org/simple" +verify_ssl = true +name = "pypi" + +[packages] +mkdocs-material = "*" +mkdocs-print-site-plugin = "*" +mkdocs-macros-plugin = "*" + +[dev-packages] + +[requires] +python_version = "3.9" diff --git a/Pipfile.lock b/Pipfile.lock new file mode 100644 index 0000000..3daaf80 --- /dev/null +++ b/Pipfile.lock @@ -0,0 +1,353 @@ +{ + "_meta": { + "hash": { + "sha256": "612aef43125956340653e2f5d349f3a26c09d8b87dd08101feccb8ed57659b89" + }, + "pipfile-spec": 6, + "requires": { + "python_version": "3.9" + }, + "sources": [ + { + "name": "pypi", + "url": "https://pypi.org/simple", + "verify_ssl": true + } + ] + }, + "default": { + "click": { + "hashes": [ + "sha256:d2b5255c7c6349bc1bd1e59e08cd12acbbd63ce649f2588755783aa94dfb6b1a", + "sha256:dacca89f4bfadd5de3d7489b7c8a566eee0d3676333fbb50030263894c38c0dc" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'", + "version": "==7.1.2" + }, + "future": { + "hashes": [ + "sha256:b1bead90b70cf6ec3f0710ae53a525360fa360d306a86583adc6bf83a4db537d" + ], + "markers": "python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2'", + "version": "==0.18.2" + }, + "jinja2": { + "hashes": [ + "sha256:03e47ad063331dd6a3f04a43eddca8a966a26ba0c5b7207a9a9e4e08f1b29419", + "sha256:a6d58433de0ae800347cab1fa3043cebbabe8baa9d29e668f1c768cb87a333c6" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'", + "version": "==2.11.3" + }, + "joblib": { + "hashes": [ + "sha256:9c17567692206d2f3fb9ecf5e991084254fe631665c450b443761c4186a613f7", + "sha256:feeb1ec69c4d45129954f1b7034954241eedfd6ba39b5e9e4b6883be3332d5e5" + ], + "markers": "python_version >= '3.6'", + "version": "==1.0.1" + }, + "livereload": { + "hashes": [ + "sha256:776f2f865e59fde56490a56bcc6773b6917366bce0c267c60ee8aaf1a0959869" + ], + "version": "==2.6.3" + }, + "lunr": { + "extras": [ + "languages" + ], + "hashes": [ + "sha256:aab3f489c4d4fab4c1294a257a30fec397db56f0a50273218ccc3efdbf01d6ca", + "sha256:c4fb063b98eff775dd638b3df380008ae85e6cb1d1a24d1cd81a10ef6391c26e" + ], + "version": "==0.5.8" + }, + "markdown": { + "hashes": [ + "sha256:31b5b491868dcc87d6c24b7e3d19a0d730d59d3e46f4eea6430a321bed387a49", + "sha256:96c3ba1261de2f7547b46a00ea8463832c921d3f9d6aba3f255a6f71386db20c" + ], + "markers": "python_version >= '3.6'", + "version": "==3.3.4" + }, + "markupsafe": { + "hashes": [ + "sha256:00bc623926325b26bb9605ae9eae8a215691f33cae5df11ca5424f06f2d1f473", + "sha256:09027a7803a62ca78792ad89403b1b7a73a01c8cb65909cd876f7fcebd79b161", + "sha256:09c4b7f37d6c648cb13f9230d847adf22f8171b1ccc4d5682398e77f40309235", + "sha256:1027c282dad077d0bae18be6794e6b6b8c91d58ed8a8d89a89d59693b9131db5", + "sha256:13d3144e1e340870b25e7b10b98d779608c02016d5184cfb9927a9f10c689f42", + "sha256:195d7d2c4fbb0ee8139a6cf67194f3973a6b3042d742ebe0a9ed36d8b6f0c07f", + "sha256:22c178a091fc6630d0d045bdb5992d2dfe14e3259760e713c490da5323866c39", + "sha256:24982cc2533820871eba85ba648cd53d8623687ff11cbb805be4ff7b4c971aff", + "sha256:29872e92839765e546828bb7754a68c418d927cd064fd4708fab9fe9c8bb116b", + "sha256:2beec1e0de6924ea551859edb9e7679da6e4870d32cb766240ce17e0a0ba2014", + "sha256:3b8a6499709d29c2e2399569d96719a1b21dcd94410a586a18526b143ec8470f", + "sha256:43a55c2930bbc139570ac2452adf3d70cdbb3cfe5912c71cdce1c2c6bbd9c5d1", + "sha256:46c99d2de99945ec5cb54f23c8cd5689f6d7177305ebff350a58ce5f8de1669e", + "sha256:500d4957e52ddc3351cabf489e79c91c17f6e0899158447047588650b5e69183", + "sha256:535f6fc4d397c1563d08b88e485c3496cf5784e927af890fb3c3aac7f933ec66", + "sha256:596510de112c685489095da617b5bcbbac7dd6384aeebeda4df6025d0256a81b", + "sha256:62fe6c95e3ec8a7fad637b7f3d372c15ec1caa01ab47926cfdf7a75b40e0eac1", + "sha256:6788b695d50a51edb699cb55e35487e430fa21f1ed838122d722e0ff0ac5ba15", + "sha256:6dd73240d2af64df90aa7c4e7481e23825ea70af4b4922f8ede5b9e35f78a3b1", + "sha256:6f1e273a344928347c1290119b493a1f0303c52f5a5eae5f16d74f48c15d4a85", + "sha256:6fffc775d90dcc9aed1b89219549b329a9250d918fd0b8fa8d93d154918422e1", + "sha256:717ba8fe3ae9cc0006d7c451f0bb265ee07739daf76355d06366154ee68d221e", + "sha256:79855e1c5b8da654cf486b830bd42c06e8780cea587384cf6545b7d9ac013a0b", + "sha256:7c1699dfe0cf8ff607dbdcc1e9b9af1755371f92a68f706051cc8c37d447c905", + "sha256:7fed13866cf14bba33e7176717346713881f56d9d2bcebab207f7a036f41b850", + "sha256:84dee80c15f1b560d55bcfe6d47b27d070b4681c699c572af2e3c7cc90a3b8e0", + "sha256:88e5fcfb52ee7b911e8bb6d6aa2fd21fbecc674eadd44118a9cc3863f938e735", + "sha256:8defac2f2ccd6805ebf65f5eeb132adcf2ab57aa11fdf4c0dd5169a004710e7d", + "sha256:98bae9582248d6cf62321dcb52aaf5d9adf0bad3b40582925ef7c7f0ed85fceb", + "sha256:98c7086708b163d425c67c7a91bad6e466bb99d797aa64f965e9d25c12111a5e", + "sha256:9add70b36c5666a2ed02b43b335fe19002ee5235efd4b8a89bfcf9005bebac0d", + "sha256:9bf40443012702a1d2070043cb6291650a0841ece432556f784f004937f0f32c", + "sha256:a6a744282b7718a2a62d2ed9d993cad6f5f585605ad352c11de459f4108df0a1", + "sha256:acf08ac40292838b3cbbb06cfe9b2cb9ec78fce8baca31ddb87aaac2e2dc3bc2", + "sha256:ade5e387d2ad0d7ebf59146cc00c8044acbd863725f887353a10df825fc8ae21", + "sha256:b00c1de48212e4cc9603895652c5c410df699856a2853135b3967591e4beebc2", + "sha256:b1282f8c00509d99fef04d8ba936b156d419be841854fe901d8ae224c59f0be5", + "sha256:b1dba4527182c95a0db8b6060cc98ac49b9e2f5e64320e2b56e47cb2831978c7", + "sha256:b2051432115498d3562c084a49bba65d97cf251f5a331c64a12ee7e04dacc51b", + "sha256:b7d644ddb4dbd407d31ffb699f1d140bc35478da613b441c582aeb7c43838dd8", + "sha256:ba59edeaa2fc6114428f1637ffff42da1e311e29382d81b339c1817d37ec93c6", + "sha256:bf5aa3cbcfdf57fa2ee9cd1822c862ef23037f5c832ad09cfea57fa846dec193", + "sha256:c8716a48d94b06bb3b2524c2b77e055fb313aeb4ea620c8dd03a105574ba704f", + "sha256:caabedc8323f1e93231b52fc32bdcde6db817623d33e100708d9a68e1f53b26b", + "sha256:cd5df75523866410809ca100dc9681e301e3c27567cf498077e8551b6d20e42f", + "sha256:cdb132fc825c38e1aeec2c8aa9338310d29d337bebbd7baa06889d09a60a1fa2", + "sha256:d53bc011414228441014aa71dbec320c66468c1030aae3a6e29778a3382d96e5", + "sha256:d73a845f227b0bfe8a7455ee623525ee656a9e2e749e4742706d80a6065d5e2c", + "sha256:d9be0ba6c527163cbed5e0857c451fcd092ce83947944d6c14bc95441203f032", + "sha256:e249096428b3ae81b08327a63a485ad0878de3fb939049038579ac0ef61e17e7", + "sha256:e8313f01ba26fbbe36c7be1966a7b7424942f670f38e666995b88d012765b9be", + "sha256:feb7b34d6325451ef96bc0e36e1a6c0c1c64bc1fbec4b854f4529e51887b1621" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", + "version": "==1.1.1" + }, + "mkdocs": { + "hashes": [ + "sha256:096f52ff52c02c7e90332d2e53da862fde5c062086e1b5356a6e392d5d60f5e9", + "sha256:f0b61e5402b99d7789efa032c7a74c90a20220a9c81749da06dbfbcbd52ffb39" + ], + "markers": "python_version >= '3.5'", + "version": "==1.1.2" + }, + "mkdocs-macros-plugin": { + "hashes": [ + "sha256:62d294443599f011a66dcf2141bb89adee7889116725ddac8ad1a3a8330f0897", + "sha256:70f9cb691b06d9765cca38c621c7d2a85442866a9f4dfd665c0f030fd930f837" + ], + "index": "pypi", + "version": "==0.5.0" + }, + "mkdocs-macros-test": { + "hashes": [ + "sha256:c5aba3cd060f28a9804d14ff0eda38287c83373529a91dbee922038aead422f0", + "sha256:d775f23600ee006331b4c6fe57e34c5b794b7faf17d91d34bcfaf4b0a59430f3" + ], + "version": "==0.1.0" + }, + "mkdocs-material": { + "hashes": [ + "sha256:24db3f45ac8eca7424ecda93e1cb5a16fcd11d76932e65c9db710eb3113592b0", + "sha256:36b46aa1e5b47896a5a2cec129467ffcc84cf343f5296b0458a84585900cf03e" + ], + "index": "pypi", + "version": "==7.0.3" + }, + "mkdocs-material-extensions": { + "hashes": [ + "sha256:6947fb7f5e4291e3c61405bad3539d81e0b3cd62ae0d66ced018128af509c68f", + "sha256:d90c807a88348aa6d1805657ec5c0b2d8d609c110e62b9dce4daf7fa981fa338" + ], + "markers": "python_version >= '3.5'", + "version": "==1.0.1" + }, + "mkdocs-print-site-plugin": { + "hashes": [ + "sha256:b6cc3abe92f5569e943086109b9b04d5ff34669e086dab733c91bcad8efcf528", + "sha256:c1d1fa1ba6e067b1adc2cac93fbdb646f332074161266f9b48c3909e186152ad" + ], + "index": "pypi", + "version": "==1.1.0" + }, + "nltk": { + "hashes": [ + "sha256:845365449cd8c5f9731f7cb9f8bd6fd0767553b9d53af9eb1b3abf7700936b35" + ], + "version": "==3.5" + }, + "pygments": { + "hashes": [ + "sha256:37a13ba168a02ac54cc5891a42b1caec333e59b66addb7fa633ea8a6d73445c0", + "sha256:b21b072d0ccdf29297a82a2363359d99623597b8a265b8081760e4d0f7153c88" + ], + "markers": "python_version >= '3.5'", + "version": "==2.8.0" + }, + "pymdown-extensions": { + "hashes": [ + "sha256:478b2c04513fbb2db61688d5f6e9030a92fb9be14f1f383535c43f7be9dff95b", + "sha256:632371fa3bf1b21a0e3f4063010da59b41db049f261f4c0b0872069a9b6d1735" + ], + "markers": "python_version >= '3.6'", + "version": "==8.1.1" + }, + "python-dateutil": { + "hashes": [ + "sha256:73ebfe9dbf22e832286dafa60473e4cd239f8592f699aa5adaf10050e6e1823c", + "sha256:75bb3f31ea686f1197762692a9ee6a7550b59fc6ca3a1f4b5d7e32fb98e2da2a" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2'", + "version": "==2.8.1" + }, + "pyyaml": { + "hashes": [ + "sha256:08682f6b72c722394747bddaf0aa62277e02557c0fd1c42cb853016a38f8dedf", + "sha256:0f5f5786c0e09baddcd8b4b45f20a7b5d61a7e7e99846e3c799b05c7c53fa696", + "sha256:129def1b7c1bf22faffd67b8f3724645203b79d8f4cc81f674654d9902cb4393", + "sha256:294db365efa064d00b8d1ef65d8ea2c3426ac366c0c4368d930bf1c5fb497f77", + "sha256:3b2b1824fe7112845700f815ff6a489360226a5609b96ec2190a45e62a9fc922", + "sha256:3bd0e463264cf257d1ffd2e40223b197271046d09dadf73a0fe82b9c1fc385a5", + "sha256:4465124ef1b18d9ace298060f4eccc64b0850899ac4ac53294547536533800c8", + "sha256:49d4cdd9065b9b6e206d0595fee27a96b5dd22618e7520c33204a4a3239d5b10", + "sha256:4e0583d24c881e14342eaf4ec5fbc97f934b999a6828693a99157fde912540cc", + "sha256:5accb17103e43963b80e6f837831f38d314a0495500067cb25afab2e8d7a4018", + "sha256:607774cbba28732bfa802b54baa7484215f530991055bb562efbed5b2f20a45e", + "sha256:6c78645d400265a062508ae399b60b8c167bf003db364ecb26dcab2bda048253", + "sha256:74c1485f7707cf707a7aef42ef6322b8f97921bd89be2ab6317fd782c2d53183", + "sha256:8c1be557ee92a20f184922c7b6424e8ab6691788e6d86137c5d93c1a6ec1b8fb", + "sha256:bb4191dfc9306777bc594117aee052446b3fa88737cd13b7188d0e7aa8162185", + "sha256:c20cfa2d49991c8b4147af39859b167664f2ad4561704ee74c1de03318e898db", + "sha256:d2d9808ea7b4af864f35ea216be506ecec180628aced0704e34aca0b040ffe46", + "sha256:dd5de0646207f053eb0d6c74ae45ba98c3395a571a2891858e87df7c9b9bd51b", + "sha256:e1d4970ea66be07ae37a3c2e48b5ec63f7ba6804bdddfdbd3cfd954d25a82e63", + "sha256:e4fac90784481d221a8e4b1162afa7c47ed953be40d31ab4629ae917510051df", + "sha256:fa5ae20527d8e831e8230cbffd9f8fe952815b2b7dae6ffec25318803a7528fc" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4, 3.5'", + "version": "==5.4.1" + }, + "regex": { + "hashes": [ + "sha256:02951b7dacb123d8ea6da44fe45ddd084aa6777d4b2454fa0da61d569c6fa538", + "sha256:0d08e71e70c0237883d0bef12cad5145b84c3705e9c6a588b2a9c7080e5af2a4", + "sha256:1862a9d9194fae76a7aaf0150d5f2a8ec1da89e8b55890b1786b8f88a0f619dc", + "sha256:1ab79fcb02b930de09c76d024d279686ec5d532eb814fd0ed1e0051eb8bd2daa", + "sha256:1fa7ee9c2a0e30405e21031d07d7ba8617bc590d391adfc2b7f1e8b99f46f444", + "sha256:262c6825b309e6485ec2493ffc7e62a13cf13fb2a8b6d212f72bd53ad34118f1", + "sha256:2a11a3e90bd9901d70a5b31d7dd85114755a581a5da3fc996abfefa48aee78af", + "sha256:2c99e97d388cd0a8d30f7c514d67887d8021541b875baf09791a3baad48bb4f8", + "sha256:3128e30d83f2e70b0bed9b2a34e92707d0877e460b402faca908c6667092ada9", + "sha256:38c8fd190db64f513fe4e1baa59fed086ae71fa45083b6936b52d34df8f86a88", + "sha256:3bddc701bdd1efa0d5264d2649588cbfda549b2899dc8d50417e47a82e1387ba", + "sha256:4902e6aa086cbb224241adbc2f06235927d5cdacffb2425c73e6570e8d862364", + "sha256:49cae022fa13f09be91b2c880e58e14b6da5d10639ed45ca69b85faf039f7a4e", + "sha256:56e01daca75eae420bce184edd8bb341c8eebb19dd3bce7266332258f9fb9dd7", + "sha256:5862975b45d451b6db51c2e654990c1820523a5b07100fc6903e9c86575202a0", + "sha256:6a8ce43923c518c24a2579fda49f093f1397dad5d18346211e46f134fc624e31", + "sha256:6c54ce4b5d61a7129bad5c5dc279e222afd00e721bf92f9ef09e4fae28755683", + "sha256:6e4b08c6f8daca7d8f07c8d24e4331ae7953333dbd09c648ed6ebd24db5a10ee", + "sha256:717881211f46de3ab130b58ec0908267961fadc06e44f974466d1887f865bd5b", + "sha256:749078d1eb89484db5f34b4012092ad14b327944ee7f1c4f74d6279a6e4d1884", + "sha256:7913bd25f4ab274ba37bc97ad0e21c31004224ccb02765ad984eef43e04acc6c", + "sha256:7a25fcbeae08f96a754b45bdc050e1fb94b95cab046bf56b016c25e9ab127b3e", + "sha256:83d6b356e116ca119db8e7c6fc2983289d87b27b3fac238cfe5dca529d884562", + "sha256:8b882a78c320478b12ff024e81dc7d43c1462aa4a3341c754ee65d857a521f85", + "sha256:8f6a2229e8ad946e36815f2a03386bb8353d4bde368fdf8ca5f0cb97264d3b5c", + "sha256:9801c4c1d9ae6a70aeb2128e5b4b68c45d4f0af0d1535500884d644fa9b768c6", + "sha256:a15f64ae3a027b64496a71ab1f722355e570c3fac5ba2801cafce846bf5af01d", + "sha256:a3d748383762e56337c39ab35c6ed4deb88df5326f97a38946ddd19028ecce6b", + "sha256:a63f1a07932c9686d2d416fb295ec2c01ab246e89b4d58e5fa468089cab44b70", + "sha256:b2b1a5ddae3677d89b686e5c625fc5547c6e492bd755b520de5332773a8af06b", + "sha256:b2f4007bff007c96a173e24dcda236e5e83bde4358a557f9ccf5e014439eae4b", + "sha256:baf378ba6151f6e272824b86a774326f692bc2ef4cc5ce8d5bc76e38c813a55f", + "sha256:bafb01b4688833e099d79e7efd23f99172f501a15c44f21ea2118681473fdba0", + "sha256:bba349276b126947b014e50ab3316c027cac1495992f10e5682dc677b3dfa0c5", + "sha256:c084582d4215593f2f1d28b65d2a2f3aceff8342aa85afd7be23a9cad74a0de5", + "sha256:d1ebb090a426db66dd80df8ca85adc4abfcbad8a7c2e9a5ec7513ede522e0a8f", + "sha256:d2d8ce12b7c12c87e41123997ebaf1a5767a5be3ec545f64675388970f415e2e", + "sha256:e32f5f3d1b1c663af7f9c4c1e72e6ffe9a78c03a31e149259f531e0fed826512", + "sha256:e3faaf10a0d1e8e23a9b51d1900b72e1635c2d5b0e1bea1c18022486a8e2e52d", + "sha256:f7d29a6fc4760300f86ae329e3b6ca28ea9c20823df123a2ea8693e967b29917", + "sha256:f8f295db00ef5f8bae530fc39af0b40486ca6068733fb860b42115052206466f" + ], + "version": "==2020.11.13" + }, + "six": { + "hashes": [ + "sha256:30639c035cdb23534cd4aa2dd52c3bf48f06e5f4a941509c8bafd8ce11080259", + "sha256:8b74bedcbbbaca38ff6d7491d76f2b06b3592611af620f8426e82dddb04a5ced" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2'", + "version": "==1.15.0" + }, + "termcolor": { + "hashes": [ + "sha256:1d6d69ce66211143803fbc56652b41d73b4a400a2891d7bf7a1cdf4c02de613b" + ], + "version": "==1.1.0" + }, + "tornado": { + "hashes": [ + "sha256:0a00ff4561e2929a2c37ce706cb8233b7907e0cdc22eab98888aca5dd3775feb", + "sha256:0d321a39c36e5f2c4ff12b4ed58d41390460f798422c4504e09eb5678e09998c", + "sha256:1e8225a1070cd8eec59a996c43229fe8f95689cb16e552d130b9793cb570a288", + "sha256:20241b3cb4f425e971cb0a8e4ffc9b0a861530ae3c52f2b0434e6c1b57e9fd95", + "sha256:25ad220258349a12ae87ede08a7b04aca51237721f63b1808d39bdb4b2164558", + "sha256:33892118b165401f291070100d6d09359ca74addda679b60390b09f8ef325ffe", + "sha256:33c6e81d7bd55b468d2e793517c909b139960b6c790a60b7991b9b6b76fb9791", + "sha256:3447475585bae2e77ecb832fc0300c3695516a47d46cefa0528181a34c5b9d3d", + "sha256:34ca2dac9e4d7afb0bed4677512e36a52f09caa6fded70b4e3e1c89dbd92c326", + "sha256:3e63498f680547ed24d2c71e6497f24bca791aca2fe116dbc2bd0ac7f191691b", + "sha256:548430be2740e327b3fe0201abe471f314741efcb0067ec4f2d7dcfb4825f3e4", + "sha256:6196a5c39286cc37c024cd78834fb9345e464525d8991c21e908cc046d1cc02c", + "sha256:61b32d06ae8a036a6607805e6720ef00a3c98207038444ba7fd3d169cd998910", + "sha256:6286efab1ed6e74b7028327365cf7346b1d777d63ab30e21a0f4d5b275fc17d5", + "sha256:65d98939f1a2e74b58839f8c4dab3b6b3c1ce84972ae712be02845e65391ac7c", + "sha256:66324e4e1beede9ac79e60f88de548da58b1f8ab4b2f1354d8375774f997e6c0", + "sha256:6c77c9937962577a6a76917845d06af6ab9197702a42e1346d8ae2e76b5e3675", + "sha256:70dec29e8ac485dbf57481baee40781c63e381bebea080991893cd297742b8fd", + "sha256:7250a3fa399f08ec9cb3f7b1b987955d17e044f1ade821b32e5f435130250d7f", + "sha256:748290bf9112b581c525e6e6d3820621ff020ed95af6f17fedef416b27ed564c", + "sha256:7da13da6f985aab7f6f28debab00c67ff9cbacd588e8477034c0652ac141feea", + "sha256:8f959b26f2634a091bb42241c3ed8d3cedb506e7c27b8dd5c7b9f745318ddbb6", + "sha256:9de9e5188a782be6b1ce866e8a51bc76a0fbaa0e16613823fc38e4fc2556ad05", + "sha256:a48900ecea1cbb71b8c71c620dee15b62f85f7c14189bdeee54966fbd9a0c5bd", + "sha256:b87936fd2c317b6ee08a5741ea06b9d11a6074ef4cc42e031bc6403f82a32575", + "sha256:c77da1263aa361938476f04c4b6c8916001b90b2c2fdd92d8d535e1af48fba5a", + "sha256:cb5ec8eead331e3bb4ce8066cf06d2dfef1bfb1b2a73082dfe8a161301b76e37", + "sha256:cc0ee35043162abbf717b7df924597ade8e5395e7b66d18270116f8745ceb795", + "sha256:d14d30e7f46a0476efb0deb5b61343b1526f73ebb5ed84f23dc794bdb88f9d9f", + "sha256:d371e811d6b156d82aa5f9a4e08b58debf97c302a35714f6f45e35139c332e32", + "sha256:d3d20ea5782ba63ed13bc2b8c291a053c8d807a8fa927d941bd718468f7b950c", + "sha256:d3f7594930c423fd9f5d1a76bee85a2c36fd8b4b16921cae7e965f22575e9c01", + "sha256:dcef026f608f678c118779cd6591c8af6e9b4155c44e0d1bc0c87c036fb8c8c4", + "sha256:e0791ac58d91ac58f694d8d2957884df8e4e2f6687cdf367ef7eb7497f79eaa2", + "sha256:e385b637ac3acaae8022e7e47dfa7b83d3620e432e3ecb9a3f7f58f150e50921", + "sha256:e519d64089b0876c7b467274468709dadf11e41d65f63bba207e04217f47c085", + "sha256:e7229e60ac41a1202444497ddde70a48d33909e484f96eb0da9baf8dc68541df", + "sha256:ed3ad863b1b40cd1d4bd21e7498329ccaece75db5a5bf58cd3c9f130843e7102", + "sha256:f0ba29bafd8e7e22920567ce0d232c26d4d47c8b5cf4ed7b562b5db39fa199c5", + "sha256:fa2ba70284fa42c2a5ecb35e322e68823288a4251f9ba9cc77be04ae15eada68", + "sha256:fba85b6cd9c39be262fcd23865652920832b61583de2a2ca907dbd8e8a8c81e5" + ], + "markers": "python_version >= '3.5'", + "version": "==6.1" + }, + "tqdm": { + "hashes": [ + "sha256:2c44efa73b8914dba7807aefd09653ac63c22b5b4ea34f7a80973f418f1a3089", + "sha256:c23ac707e8e8aabb825e4d91f8e17247f9cc14b0d64dd9e97be0781e9e525bba" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", + "version": "==4.58.0" + } + }, + "develop": {} +} diff --git a/README.md b/README.md index 64a9f23..76af185 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Cookiecutter KiCad +# Cookiecutter KiCAD ## Powered by [Cookiecutter](https://cookiecutter.readthedocs.io/en/latest/), Cookiecutter KiCad generates boilerplate for production-ready [KiCad](https://www.kicad.org) projects. @@ -86,7 +86,7 @@ Would you like to learn more? Check out the links below! Documentation](https://cookiecutter.readthedocs.io/en/latest/) * [Cookiecutter: Project Templates Made Easy](https://www.pydanny.com/cookie-project-templates-made-easy.html) -* [KiCad](https://www.kicad.org) +* [KiCAD](https://www.kicad.org) ## Author diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 0000000..a2a9f0f --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1,4 @@ +--- +title: Changelog +--- +--8<-- "./CHANGELOG.md" \ No newline at end of file diff --git a/docs/contributors.md b/docs/contributors.md new file mode 100644 index 0000000..974a475 --- /dev/null +++ b/docs/contributors.md @@ -0,0 +1,4 @@ +--- +title: Contributors +--- +--8<-- "./CONTRIBUTORS.md" \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..f046aec --- /dev/null +++ b/docs/index.md @@ -0,0 +1,7 @@ +# Welcome to Cookiecutter for KiCAD + +This is a cookiecutter boiler plate for a hardware project using KiCAD + +--8<-- "./README.md" + + diff --git a/docs/license.md b/docs/license.md new file mode 100644 index 0000000..a0195c0 --- /dev/null +++ b/docs/license.md @@ -0,0 +1,3 @@ +# License + +--8<-- "./LICENSE" diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..ae8712d --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,68 @@ +# project information +site_name: "cookiecutter-kicad" +site_author: "Stephen Eaton" +site_description: "Cookiecutter template for KiCAD Hardware projects" + +# Configuration +theme: + name: material + features: + - navigation.tabs + - header.autohide + +# Repository +repo_name: "madeinoz67/cookiecutter-kicad" +repo_url: "https://github.com/madeinoz67/cookiecutter-kicad" + +# plugins +plugins: + - search + #- macros + - print-site # <- needs to be last plugin + +# extensions +markdown_extensions: + - abbr + - attr_list + - admonition + - footnotes + - meta + - pymdownx.details + - pymdownx.snippets + - pymdownx.smartsymbols + - pymdownx.caret + - pymdownx.mark + - pymdownx.tabbed + - pymdownx.tilde + - pymdownx.highlight + - pymdownx.superfences + - pymdownx.keys + - pymdownx.arithmatex: + generic: true + - pymdownx.emoji: + emoji_index: !!python/name:materialx.emoji.twemoji + emoji_generator: !!python/name:materialx.emoji.to_svg + +# Copyright +copyright: Copyright © 2021 Stephen Eaton + +# footer customisation +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/madeinoz67 + - icon: fontawesome/brands/twitter + link: "https://twitter.com/madeinoz" + +# Page Tree +nav: + - Getting Started: + - index.md + - license.md + - Change Log: changelog.md + - Contributors: contributors.md + - References: index.md #TODO: References Documentation page +# Google Analytics +#google_analytics: +# - !!python/object/apply:os.getenv ["GOOGLE_ANALYTICS_KEY"] +# - auto diff --git a/{{cookiecutter.project_name}}/AUTHORS.rst b/{{cookiecutter.project_name}}/AUTHORS.rst index 977a847..fe57b70 100644 --- a/{{cookiecutter.project_name}}/AUTHORS.rst +++ b/{{cookiecutter.project_name}}/AUTHORS.rst @@ -8,4 +8,4 @@ Leads - {{ cookiecutter.project_author }} '@{{ cookiecutter.github_user}} ' Contributors (chronological) -============================ \ No newline at end of file +============================ diff --git a/{{cookiecutter.project_name}}/Pipfile.lock b/{{cookiecutter.project_name}}/Pipfile.lock index b9bb4ee..5c105f1 100644 --- a/{{cookiecutter.project_name}}/Pipfile.lock +++ b/{{cookiecutter.project_name}}/Pipfile.lock @@ -1,7 +1,7 @@ { "_meta": { "hash": { - "sha256": "18099441497d7ba26eac6ba834092fdb5e6889ebb6afcd5b1eb25045309c574d" + "sha256": "612aef43125956340653e2f5d349f3a26c09d8b87dd08101feccb8ed57659b89" }, "pipfile-spec": 6, "requires": { @@ -137,6 +137,21 @@ "markers": "python_version >= '3.5'", "version": "==1.1.2" }, + "mkdocs-macros-plugin": { + "hashes": [ + "sha256:62d294443599f011a66dcf2141bb89adee7889116725ddac8ad1a3a8330f0897", + "sha256:70f9cb691b06d9765cca38c621c7d2a85442866a9f4dfd665c0f030fd930f837" + ], + "index": "pypi", + "version": "==0.5.0" + }, + "mkdocs-macros-test": { + "hashes": [ + "sha256:c5aba3cd060f28a9804d14ff0eda38287c83373529a91dbee922038aead422f0", + "sha256:d775f23600ee006331b4c6fe57e34c5b794b7faf17d91d34bcfaf4b0a59430f3" + ], + "version": "==0.1.0" + }, "mkdocs-material": { "hashes": [ "sha256:853b9276a32700fed7fbdf608d6ac39297edcdf8cb683c6337acb412d9c7bb57", @@ -183,6 +198,14 @@ "markers": "python_version >= '3.6'", "version": "==8.1.1" }, + "python-dateutil": { + "hashes": [ + "sha256:73ebfe9dbf22e832286dafa60473e4cd239f8592f699aa5adaf10050e6e1823c", + "sha256:75bb3f31ea686f1197762692a9ee6a7550b59fc6ca3a1f4b5d7e32fb98e2da2a" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", + "version": "==2.8.1" + }, "pyyaml": { "hashes": [ "sha256:08682f6b72c722394747bddaf0aa62277e02557c0fd1c42cb853016a38f8dedf", @@ -264,6 +287,12 @@ "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", "version": "==1.15.0" }, + "termcolor": { + "hashes": [ + "sha256:1d6d69ce66211143803fbc56652b41d73b4a400a2891d7bf7a1cdf4c02de613b" + ], + "version": "==1.1.0" + }, "tornado": { "hashes": [ "sha256:0a00ff4561e2929a2c37ce706cb8233b7907e0cdc22eab98888aca5dd3775feb", diff --git a/{{cookiecutter.project_name}}/README.md b/{{cookiecutter.project_name}}/README.md index 3733702..eb735ae 100644 --- a/{{cookiecutter.project_name}}/README.md +++ b/{{cookiecutter.project_name}}/README.md @@ -21,4 +21,4 @@ Below are some handy resource links. * **{{ cookiecutter.author_name }}** - *Initial Work* - [github](https://github.com/{{cookiecutter.github_user}}) -See also the list of [contributors](https://github.com/{{cookiecutter.github_user}}/{{cookiecutter.project_github_repo_name}}/contributors) who participated in this project. +See also the list of [contributors](https://github.com/{{cookiecutter.github_user}}/{{cookiecutter.project_github_repo_name}}/AUTHORS.rst) who participated in this project. diff --git a/{{cookiecutter.project_name}}/docs/contributors.md b/{{cookiecutter.project_name}}/docs/contributors.md index 5732d11..9520602 100644 --- a/{{cookiecutter.project_name}}/docs/contributors.md +++ b/{{cookiecutter.project_name}}/docs/contributors.md @@ -1 +1,4 @@ +--- +title: Getting started +--- --8<-- "./AUTHORS.rst" \ No newline at end of file diff --git a/{{cookiecutter.project_name}}/docs/firmware.md b/{{cookiecutter.project_name}}/docs/firmware.md new file mode 100644 index 0000000..14c2ed4 --- /dev/null +++ b/{{cookiecutter.project_name}}/docs/firmware.md @@ -0,0 +1,2 @@ + +# Firmware diff --git a/{{cookiecutter.project_name}}/docs/hardware.md b/{{cookiecutter.project_name}}/docs/hardware.md new file mode 100644 index 0000000..e293d54 --- /dev/null +++ b/{{cookiecutter.project_name}}/docs/hardware.md @@ -0,0 +1,3 @@ + +# Hardware + diff --git a/{{cookiecutter.project_name}}/docs/license.md b/{{cookiecutter.project_name}}/docs/license.md index 160fd8e..a0195c0 100644 --- a/{{cookiecutter.project_name}}/docs/license.md +++ b/{{cookiecutter.project_name}}/docs/license.md @@ -1 +1,3 @@ +# License + --8<-- "./LICENSE" diff --git a/{{cookiecutter.project_name}}/mkdocs.yml b/{{cookiecutter.project_name}}/mkdocs.yml index 2283372..3977183 100644 --- a/{{cookiecutter.project_name}}/mkdocs.yml +++ b/{{cookiecutter.project_name}}/mkdocs.yml @@ -17,15 +17,31 @@ repo_url: https://github.com/{{cookiecutter.github_user}}/{{cookiecutter.project # plugins plugins: - search + #- macros - print-site # <- needs to be last plugin # extensions markdown_extensions: - abbr + - attr_list - admonition + - footnotes + - meta - pymdownx.details - pymdownx.snippets + - pymdownx.smartsymbols + - pymdownx.caret + - pymdownx.mark + - pymdownx.tabbed + - pymdownx.tilde + - pymdownx.highlight - pymdownx.superfences + - pymdownx.keys + - pymdownx.arithmatex: + generic: true + - pymdownx.emoji: + emoji_index: !!python/name:materialx.emoji.twemoji + emoji_generator: !!python/name:materialx.emoji.to_svg # Copyright copyright: Copyright © 2021 {{cookiecutter.project_author}} @@ -38,10 +54,22 @@ extra: # Page Tree nav: - - Home: index.md + - Getting Started: + - index.md + - Hardware: + - Hardware: hardware.md + - License: license.md + - Firmware: + - Firmware: firmware.md + - License: license.md + - Bill of Materials: + - index.md + - Design: + - index.md + - Mechanical: + - index.md - Change Log: changelog.md - - Contributors: contributors.md - - License: license.md + - References: index.md # Google Analytics #google_analytics: # - !!python/object/apply:os.getenv ["GOOGLE_ANALYTICS_KEY"] diff --git a/{{cookiecutter.project_name}}/pipfile b/{{cookiecutter.project_name}}/pipfile index a73ebc0..95100f1 100644 --- a/{{cookiecutter.project_name}}/pipfile +++ b/{{cookiecutter.project_name}}/pipfile @@ -6,6 +6,7 @@ name = "pypi" [packages] mkdocs-material = "*" mkdocs-print-site-plugin = "*" +mkdocs-macros-plugin = "*" [dev-packages]