docs: add pdoc

Author: remarkablemark

.github/CONTRIBUTING.md

@@ -172,6 +172,12 @@ Install the package:
 pip install --index-url https://test.pypi.org/simple/ --no-deps python_cli_template
 ```
 
+Generate [docs](https://pdoc.dev/):
+
+```sh
+pdoc src/python_cli_template/
+```
+
 ## Release
 
 Release and publish are automated with [Release Please](https://github.com/googleapis/release-please).

.github/workflows/build.yml

@@ -2,7 +2,7 @@ name: build
 on: [push, pull_request]
 
 permissions:
-  contents: read
+  contents: write
 
 jobs:
   build:
@@ -22,3 +22,12 @@ jobs:
 
       - name: Generate packages
         run: python3 -m build
+
+      - name: Build docs
+        run: pdoc src/python_cli_template/ -o docs
+
+      - name: Deploy
+        if: github.ref_name == 'master'
+        uses: remarkablemark/gitploy-action@v1
+        with:
+          directory: docs

pyproject.toml

@@ -24,6 +24,7 @@ python_cli_template = "python_cli_template.cli:main"
 [project.optional-dependencies]
 build = [
     "build==1.2.2.post1",
+    "pdoc==15.0.1",
     "twine==6.1.0",
 ]
 test = [

src/python_cli_template/__init__.py

@@ -1,4 +1,8 @@
-"""Python CLI Template"""
+"""
+Python CLI Template
+
+.. include:: ../../README.md
+"""
 
 from .template import hello