Feature project docs generation

.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

.gitignore

@@ -0,0 +1 @@
+site/

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

CONTRIBUTORS.md

@@ -0,0 +1,8 @@
+
+Leads
+=====
+
+- Stephen Eaton '@madeinoz67 <https://github.com/madeinoz67>'
+
+Contributors (chronological)
+============================

Makefile

@@ -0,0 +1,12 @@
+
+
+.PHONY: serve build install
+
+install:
+	pipenv install
+
+build:
+	pipenv run mkdocs build
+
+serve: build
+	pipenv run mkdocs serve

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"

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
 

docs/changelog.md

@@ -0,0 +1,4 @@
+---
+title: Changelog
+---
+--8<-- "./CHANGELOG.md"

docs/contributors.md

@@ -0,0 +1,4 @@
+---
+title: Contributors
+---
+--8<-- "./CONTRIBUTORS.md"

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"
+
+

docs/license.md

@@ -0,0 +1,3 @@
+# License
+
+--8<-- "./LICENSE"

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 &copy; 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

{{cookiecutter.project_name}}/.gitignore

@@ -50,4 +50,7 @@ Network Trash Folder
 Temporary Items
 .apdisk
 
-# TODO: Add CPP / Arduino ignores
+# mkdocs
+site/
+
+#TODO: Add CPP / Arduino ignores

{{cookiecutter.project_name}}/AUTHORS.rst

@@ -0,0 +1,11 @@
+*******
+Authors
+*******
+
+Leads
+=====
+
+- {{ cookiecutter.project_author }} '@{{ cookiecutter.github_user}} <https://github.com/{{cookiecutter.github_user}}>'
+
+Contributors (chronological)
+============================

{{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