Added baseline for sphinx documentation and on2FACode event

The docs are still very WIP, but they should be functional. Just
execute `make html` in the docs folder, and you should be able to
navigate to `/docs/_build/html` and view it in your browser
This commit is contained in:
Mads Marquart
2017-05-26 13:38:54 +02:00
parent a76ebbb22a
commit d2741ca419
26 changed files with 1191 additions and 361 deletions

86
docs/intro.rst Normal file
View File

@@ -0,0 +1,86 @@
.. highlight:: python
.. _intro:
Introduction
============
.. todo::
Make a general introduction to `fbchat`
.. _intro_logging_in:
Logging in
----------
.. todo::
Write something about logging in, logging out, checking login, 2FA and the event `on2FACode`, here
.. _intro_sessions:
Sessions
--------
.. todo::
Make an introduction to and show example usage of sessions
.. _intro_sending:
Sending messages
----------------
.. todo::
Make an introduction to and show example usage of how you send information
.. literalinclude:: ../examples/send.py
:language: python
.. _intro_fetching:
Fetching information
--------------------
.. todo::
Make an introduction to and show example usage of fetching information
.. literalinclude:: ../examples/get.py
:language: python
.. _intro_thread_id:
Thread ids
----------
.. todo::
Make an introduction to and show example usage of thread ids
.. _intro_thread_type:
Thread types
------------
.. todo::
Make an introduction to and show example usage of thread types
.. _intro_message_ids:
Message ids
-----------
.. todo::
Make an introduction to and show example usage of message ids
.. _intro_events:
Events
------
.. todo::
Make an introduction to and show example usage of the event system