Skip to content

Commit

Permalink
Tweak docs and add a logo
Browse files Browse the repository at this point in the history
  • Loading branch information
Sam Mulube committed Oct 5, 2018
1 parent 7219b6a commit c68d546
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 11 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,10 @@ server stubs as well as client bindings in a number of programming languages
and can be thought of as being akin to a simpler version of
[GRPC](https://grpc.io).

## Documentation

Documentation for this library has been published to:
https://decode-datastore-client.readthedocs.io/en/latest/

Please have a look there for some more detailed installation instructions and
usage examples.
Binary file added docs/_static/images/logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,9 @@
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}
html_theme_options = {
'logo': 'images/logo.png',
}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand Down
19 changes: 9 additions & 10 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,15 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
DECODE Iot Pilot datastore_client's documentation!
==================================================
DECODE Iot Pilot Datastore Client documentation
===============================================

.. image:: https://img.shields.io/github/license/thingful/decode-datastore-client-py.svg
:target: https://github.com/thingful/decode-datastore-client-py/blob/master/LICENSE

.. image:: https://img.shields.io/github/issues/thingful/decode-datastore-client-py.svg
:target: https://github.com/thingful/decode-datastore-client-py/issues


.. toctree::
:maxdepth: 2
Expand All @@ -13,11 +20,3 @@ DECODE Iot Pilot datastore_client's documentation!
pages/intro
pages/usage



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

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

0 comments on commit c68d546

Please sign in to comment.