Add auto documentation

.gitignore

@@ -2,3 +2,5 @@
 dist/
 __pycache__/
 .mypy_cache/
+*.egg-info
+test_config.yaml

Makefile

@@ -1,22 +1,20 @@
-.PHONY: test types clean
-PROTOCOL_PATH=$(GOPATH)/src/github.com/keybase/client/protocol
-AVDLC=$(PROTOCOL_PATH)/node_modules/.bin/avdlc
+# Minimal makefile for Sphinx documentation
+#
 
-test:
-	poetry run mypy pykeybasebot/
-	poetry run python -m pytest
-	poetry run flake8
-	poetry run isort -rc . --check-only
-	poetry run black . --check
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= poetry run sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
 
-types:
-	@mkdir -p pykeybasebot/types/{keybase1,gregor1,chat1,stellar1}/
-	$(AVDLC) -b -l python -t -o pykeybasebot/types/keybase1 $(PROTOCOL_PATH)/avdl/keybase1/*.avdl
-	$(AVDLC) -b -l python -t -o pykeybasebot/types/gregor1 $(PROTOCOL_PATH)/avdl/gregor1/*.avdl
-	$(AVDLC) -b -l python -t -o pykeybasebot/types/chat1 $(PROTOCOL_PATH)/avdl/chat1/*.avdl
-	$(AVDLC) -b -l python -t -o pykeybasebot/types/stellar1 $(PROTOCOL_PATH)/avdl/stellar1/*.avdl
-	poetry run black pykeybasebot/types
-	poetry run isort pykeybasebot/types/**/*.py
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-clean:
-	rm -rf src/types/*
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

Makefile1

@@ -0,0 +1,22 @@
+.PHONY: test types clean
+PROTOCOL_PATH=$(GOPATH)/src/github.com/keybase/client/protocol
+AVDLC=$(PROTOCOL_PATH)/node_modules/.bin/avdlc
+
+test:
+	poetry run mypy pykeybasebot/
+	poetry run python -m pytest
+	poetry run flake8
+	poetry run isort -rc . --check-only
+	poetry run black . --check
+
+types:
+	@mkdir -p pykeybasebot/types/{keybase1,gregor1,chat1,stellar1}/
+	$(AVDLC) -b -l python -t -o pykeybasebot/types/keybase1 $(PROTOCOL_PATH)/avdl/keybase1/*.avdl
+	$(AVDLC) -b -l python -t -o pykeybasebot/types/gregor1 $(PROTOCOL_PATH)/avdl/gregor1/*.avdl
+	$(AVDLC) -b -l python -t -o pykeybasebot/types/chat1 $(PROTOCOL_PATH)/avdl/chat1/*.avdl
+	$(AVDLC) -b -l python -t -o pykeybasebot/types/stellar1 $(PROTOCOL_PATH)/avdl/stellar1/*.avdl
+	poetry run black pykeybasebot/types
+	poetry run isort pykeybasebot/types/**/*.py
+
+clean:
+	rm -rf src/types/*

_build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: d2362de00b8056d59aceae01144ae95e
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_build/html/_sources/index.rst.txt

@@ -0,0 +1,25 @@
+.. pykeybasebot documentation master file, created by
+   sphinx-quickstart on Mon Nov  4 10:29:46 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to pykeybasebot's documentation!
+========================================
+
+.. automodule:: pykeybasebot.bot
+    :members:
+.. automodule:: pykeybasebot.chat_client
+    :members:
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`