From 2c7f34494b333aec3dcdf654eece2a5a3c3162b2 Mon Sep 17 00:00:00 2001
From: Nico Alt <nicoalt@posteo.org>
Date: Wed, 2 Sep 2020 12:53:33 +0200
Subject: [PATCH] Setup pdoc3

---
 .gitignore             | 1 +
 README.md              | 5 +++++
 docs/.gitkeep          | 0
 requirements-dev.txt   | 2 ++
 tools/generate-docs.sh | 3 +++
 5 files changed, 11 insertions(+)
 create mode 100644 docs/.gitkeep
 create mode 100755 tools/generate-docs.sh

diff --git a/.gitignore b/.gitignore
index 9163101..d2868bd 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,4 @@
 .coverage
 __pycache__
 dist
+docs/briar_wrapper
diff --git a/README.md b/README.md
index 65d3c17..bced76e 100644
--- a/README.md
+++ b/README.md
@@ -59,6 +59,11 @@ And install the .deb like this:
 sudo dpkg -i ../python3-briar-wrapper_0.0.3-1_all.deb
 ```
 
+## Documentation
+
+The documentation of the project's code can be found in the _docs_ directory.
+To generate it, call `tools/generate-docs.sh`.
+
 ## Design Goals
 
 * Main platform is GNU/Linux, but should also support (at least) Windows and macOS
diff --git a/docs/.gitkeep b/docs/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/requirements-dev.txt b/requirements-dev.txt
index 9a90c9d..bd5df32 100644
--- a/requirements-dev.txt
+++ b/requirements-dev.txt
@@ -9,3 +9,5 @@ pytest>=5.2.1
 pytest-cov>=2.8.1
 pytest-mock>=1.11.1
 requests_mock>=1.7.0
+
+pdoc3
diff --git a/tools/generate-docs.sh b/tools/generate-docs.sh
new file mode 100755
index 0000000..5f08d36
--- /dev/null
+++ b/tools/generate-docs.sh
@@ -0,0 +1,3 @@
+#!/bin/bash
+rm -fr docs/briar_wrapper
+pdoc3 --html --force --output-dir docs briar_wrapper
-- 
GitLab