Skip to content

Commit

Permalink
Add readthedocs links to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dourvaris committed Jan 13, 2018
1 parent 9090215 commit 12d9f52
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 12 deletions.
38 changes: 28 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
========================
RaiBlocks Python Library
========================

Expand All @@ -7,6 +8,10 @@ RaiBlocks Python Library
.. image:: https://travis-ci.org/dourvaris/raiblocks-python.svg?branch=1.0.0rc1
:target: https://travis-ci.org/dourvaris/raiblocks-python

.. image:: https://readthedocs.org/projects/raiblocks-python/badge/?version=latest
:target: http://raiblocks-python.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image:: https://github.com/dourvaris/raiblocks-python/raw/master/coverage.svg?sanitize=true
:target: https://travis-ci.org/dourvaris/raiblocks-python

Expand All @@ -24,15 +29,25 @@ Also included are utilities such as converting rai/xrb and interesting accounts


Installation
------------
============

.. code-block:: text
pip install raiblocks
Documentation
=============

https://raiblocks-python.readthedocs.io/

RPC client
----------
==========

You can browse the available
`RPC methods list <https://raiblocks-python.readthedocs.io/en/latest/rpc/index.html>`_
or check the
`RPC Client API documentation <https://raiblocks-python.readthedocs.io/en/latest/raiblocks.html#module-raiblocks.rpc>`_
for examples of usage.

.. code-block:: python
Expand All @@ -51,7 +66,7 @@ RPC client
}
Conversion
----------
==========

.. code-block:: python
Expand All @@ -71,7 +86,7 @@ Conversion
Known Accounts / Constants
--------------------------
==========================

.. code-block:: python
Expand All @@ -95,7 +110,10 @@ Known Accounts / Constants
Development
-----------
==========

Setup
-----

.. code-block:: text
Expand All @@ -104,9 +122,8 @@ Development
pip install -r requirements.txt -r test-requirements.txt
python setup.py develop
Tests
-----
Running tests
-------------

.. code-block:: text
Expand All @@ -116,8 +133,9 @@ Tests
# coverage
./coverage
Docs
----
Building docs
-------------

.. code-block:: text
Expand Down
3 changes: 1 addition & 2 deletions docs/readme.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
.. include:: ../README.rst

.. include:: ../README.rst

0 comments on commit 12d9f52

Please sign in to comment.