Minor documentation update

merge-requests/130/head
Jason Robinson 2017-07-05 20:08:24 +03:00
rodzic c30ec8ee95
commit fcc38fc850
5 zmienionych plików z 10 dodań i 7 usunięć

Wyświetl plik

@ -133,7 +133,7 @@ todo_include_todos = False
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
# html_theme = 'alabaster'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the

Wyświetl plik

@ -29,9 +29,13 @@ Building local documentation
cd docs
make html
Built documentation is available at ``docs/_build/html/index.html``.
Contact for help
----------------
Easiest via FreeNode IRC, channel #python-federation (`webchat here <http://webchat.freenode.net?channels=%23python-federation&uio=d4>`_).
Easiest via FreeNode IRC, channel ``#python-federation`` (`webchat here <http://webchat.freenode.net?channels=%23python-federation&uio=d4>`_).
There is also a `Gitter chat <https://gitter.im/python-federation/Lobby>`_ available.
You can also ask questions or give feedback via issues.

Wyświetl plik

@ -14,6 +14,8 @@ lxml itself is installed by pip but the dependencies need to be installed `as pe
Installation
------------
Install with pip or include in your requirements file.::
Install with pip or include in your requirements file.
::
pip install federation

Wyświetl plik

@ -24,7 +24,6 @@ The feature set supported by this release is approximately the following:
* Retraction
* StatusMessage
Implementation unfortunately currently requires knowledge of how Diaspora discovery works a
s the implementer has to implement all the necessary views correctly (even though this library provides document generators). However, the magic envelope, signature and entity building is all abstracted inside the library.
Implementation unfortunately currently requires knowledge of how Diaspora discovery works as the implementer has to implement all the necessary views correctly (even though this library provides document generators). However, the magic envelope, signature and entity building is all abstracted inside the library.
For example implementations in real life projects check :ref:`example-projects`.

Wyświetl plik

@ -122,8 +122,6 @@ Exceptions
Various custom exception classes might be returned.
.. autoexception:: federation.exceptions.EncryptedMessageError
.. autoexception:: federation.exceptions.NoHeaderInMessageError
.. autoexception:: federation.exceptions.NoSenderKeyFoundError
.. autoexception:: federation.exceptions.NoSuitableProtocolFoundError
.. autoexception:: federation.exceptions.SignatureVerificationError