https://github.com/andgineer/docker-amazon-dash-button-hack/issues/27

docs boilerplate

Author: andgineer

.github/workflows/docs.yml

@@ -0,0 +1,27 @@
+# build docs from docstrings and markdown-file in folder docs
+# publish them as github pages
+#
+#note for myself
+#
+# Do not forget to set git branch `gh-pages` as source for github pages.
+# This branch auto-updated by `mkdocs gh-deploy`
+#
+name: docs
+on:
+  push:
+    branches:
+      - main
+      - master
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+        with:
+          python-version: 3.x
+      - run: |
+          pip install -r requirements.dev.txt
+          pip install -r requirements.txt
+      - run: scripts/build-docs.sh
+      - run: mkdocs gh-deploy --force

.gitignore

@@ -8,3 +8,4 @@ secrets/
 .coverage
 .dmypy.json
 venv/
+site/

Makefile

@@ -1,4 +1,6 @@
 #!make
+.PHONY: docs
+
 VERSION := $(shell cat src/version.py | cut -d= -f2 | sed 's/\"//g; s/ //')
 export VERSION
 
@@ -19,3 +21,6 @@ reqs:
 	bash ./scripts/compile_requirements.sh
 	pip install -r requirements.txt
 	pip install -r requirements.dev.txt
+
+docs:
+	bash ./scripts/build-docs.sh

mkdocs.yml

@@ -0,0 +1,16 @@
+site_name: docker-amazon-dash-button-hack
+site_url: https://andgineer.github.io/docker-amazon-dash-button-hack
+site_author: Andrey Sorokin
+
+# Repository
+repo_name: docker-amazon-dash-button-hack
+repo_url: https://github.com/andgineer/docker-amazon-dash-button-hack
+edit_uri: edit/master/docs
+docs_dir: docs
+
+plugins:
+  - awesome-pages
+  - search
+
+theme:
+  name: readthedocs

requirements.dev.in

@@ -1,7 +1,15 @@
+# dependencies list to build requirements.dev.txt with pip-compile (from pip-tools package)
 pytest
 types-requests
 types-python-dateutil
 coverage
 pytest-mock
 requests-mock
 freezegun
+pydocstyle
+pre-commit
+pip-tools
+
+lazydocs
+mkdocs
+mkdocs-awesome-pages-plugin

requirements.dev.txt

@@ -4,32 +4,99 @@
 #
 #    pip-compile requirements.dev.in
 #
+bracex==2.4
+    # via wcmatch
+build==1.0.3
+    # via pip-tools
 certifi==2023.7.22
     # via requests
+cfgv==3.4.0
+    # via pre-commit
 charset-normalizer==3.2.0
     # via requests
+click==8.1.7
+    # via
+    #   mkdocs
+    #   pip-tools
+    #   typer
 coverage==7.3.1
     # via -r requirements.dev.in
+distlib==0.3.7
+    # via virtualenv
 exceptiongroup==1.1.3
     # via pytest
+filelock==3.12.4
+    # via virtualenv
 freezegun==1.2.2
     # via -r requirements.dev.in
+ghp-import==2.1.0
+    # via mkdocs
+identify==2.5.29
+    # via pre-commit
 idna==3.4
     # via requests
 iniconfig==2.0.0
     # via pytest
+jinja2==3.1.2
+    # via mkdocs
+lazydocs==0.4.8
+    # via -r requirements.dev.in
+markdown==3.4.4
+    # via mkdocs
+markupsafe==2.1.3
+    # via
+    #   jinja2
+    #   mkdocs
+mergedeep==1.3.4
+    # via mkdocs
+mkdocs==1.5.2
+    # via
+    #   -r requirements.dev.in
+    #   mkdocs-awesome-pages-plugin
+mkdocs-awesome-pages-plugin==2.9.2
+    # via -r requirements.dev.in
+natsort==8.4.0
+    # via mkdocs-awesome-pages-plugin
+nodeenv==1.8.0
+    # via pre-commit
 packaging==23.1
-    # via pytest
+    # via
+    #   build
+    #   mkdocs
+    #   pytest
+pathspec==0.11.2
+    # via mkdocs
+pip-tools==7.3.0
+    # via -r requirements.dev.in
+platformdirs==3.10.0
+    # via
+    #   mkdocs
+    #   virtualenv
 pluggy==1.3.0
     # via pytest
+pre-commit==3.4.0
+    # via -r requirements.dev.in
+pydocstyle==6.3.0
+    # via -r requirements.dev.in
+pyproject-hooks==1.0.0
+    # via build
 pytest==7.4.2
     # via
     #   -r requirements.dev.in
     #   pytest-mock
 pytest-mock==3.11.1
     # via -r requirements.dev.in
 python-dateutil==2.8.2
-    # via freezegun
+    # via
+    #   freezegun
+    #   ghp-import
+pyyaml==6.0.1
+    # via
+    #   mkdocs
+    #   pre-commit
+    #   pyyaml-env-tag
+pyyaml-env-tag==0.1
+    # via mkdocs
 requests==2.31.0
     # via requests-mock
 requests-mock==1.11.0
@@ -38,13 +105,35 @@ six==1.16.0
     # via
     #   python-dateutil
     #   requests-mock
+snowballstemmer==2.2.0
+    # via pydocstyle
 tomli==2.0.1
-    # via pytest
+    # via
+    #   build
+    #   pip-tools
+    #   pyproject-hooks
+    #   pytest
+typer==0.9.0
+    # via lazydocs
 types-python-dateutil==2.8.19.14
     # via -r requirements.dev.in
 types-requests==2.31.0.2
     # via -r requirements.dev.in
 types-urllib3==1.26.25.14
     # via types-requests
+typing-extensions==4.8.0
+    # via typer
 urllib3==2.0.4
     # via requests
+virtualenv==20.24.5
+    # via pre-commit
+watchdog==3.0.0
+    # via mkdocs
+wcmatch==8.5
+    # via mkdocs-awesome-pages-plugin
+wheel==0.41.2
+    # via pip-tools
+
+# The following packages are considered to be unsafe in a requirements file:
+# pip
+# setuptools

requirements.in

@@ -1,3 +1,4 @@
+# dependencies list to build requirements.txt with pip-compile (from pip-tools package)
 python-dateutil
 scapy
 oauth2client

scripts/build-docs.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+#
+# Create docs in docs/
+#
+
+lazydocs \
+    --output-path="./docs/docstrings" \
+    --overview-file="README.md" \
+    --src-base-url="https://github.com/andgineer/docker-amazon-dash-button-hack/blob/master/" \
+    src
+
+mkdocs build