diff --git a/docs/conf.py b/docs/conf.py index a7448e6..35cbf8f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 diff --git a/docs/development.rst b/docs/development.rst index ea9e4bc..e064d87 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -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 `_). +Easiest via FreeNode IRC, channel ``#python-federation`` (`webchat here `_). + +There is also a `Gitter chat `_ available. You can also ask questions or give feedback via issues. diff --git a/docs/install.rst b/docs/install.rst index c76d5c2..60c4437 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -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 diff --git a/docs/protocols.rst b/docs/protocols.rst index 5ecc1c2..17749e7 100644 --- a/docs/protocols.rst +++ b/docs/protocols.rst @@ -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`. diff --git a/docs/usage.rst b/docs/usage.rst index 14ed143..c4dcf4a 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -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 -