Skip to content
This repository was archived by the owner on Jan 24, 2025. It is now read-only.
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
/pykeybasebot/types/ linguist-generated=true
docsrc/* linguist-documentation
docs/* linguist-documentation
8 changes: 8 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
PROTOCOL_PATH=$(GOPATH)/src/github.com/keybase/client/protocol
AVDLC=$(PROTOCOL_PATH)/node_modules/.bin/avdlc

documentation:
mkdir -p docs
touch docs/.nojekyll
poetry run make -C docsrc html
cp -a docsrc/_build/html/* docs
@echo "Documentation successfully built!"


test:
poetry run mypy pykeybasebot/
poetry run python -m pytest
Expand Down
Empty file added docs/.nojekyll
Empty file.
17 changes: 17 additions & 0 deletions docs/_sources/api.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
API Reference
=============
.. automodule:: pykeybasebot.bot
:members:

.. automodule:: pykeybasebot.cli
:members:

.. automodule:: pykeybasebot.chat_client
:members:

.. automodule:: pykeybasebot.errors
:members:

.. automodule:: pykeybasebot.kbevent
:members:

20 changes: 20 additions & 0 deletions docs/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
.. Python Keybase Bot documentation master file, created by
sphinx-quickstart on Sun Nov 17 16:53:04 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

Welcome to Python Keybase Bot's documentation!
==============================================

.. toctree::
:maxdepth: 2
:caption: Contents:

api

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Loading