diff --git a/.gitignore b/.gitignore index 916310186161f529a990d7889b9ea52fcba8f986..d2868bda8b251ff127c3d18838134283d3ef5b8c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ .coverage __pycache__ dist +docs/briar_wrapper diff --git a/README.md b/README.md index 65d3c17dbb66cff354d6d58f8155eba95d229683..bced76e7136504ad9f1425b675ac99245ee5f18d 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 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/requirements-dev.txt b/requirements-dev.txt index 9a90c9dc0df40aeaa39a18358fe247c552315e76..bd5df320182b77472c8a487a59a1236480e06118 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 0000000000000000000000000000000000000000..5f08d363046de747a7cff1ef0ef56fbb2de8c286 --- /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