Skip to content

Commit

Permalink
Bugfix the docs, after changing conf.py
Browse files Browse the repository at this point in the history
  • Loading branch information
bcb committed Sep 28, 2016
1 parent 8f1f282 commit a28bf2b
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
14 changes: 7 additions & 7 deletions doc/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ jsonrpcclient API
Request
=======

.. automethod:: client.Client.request
.. automethod:: jsonrpcclient.client.Client.request

If you're not interested in a response, use ``notify()`` instead of
``request()``.

Send
====

.. automethod:: client.Client.send
.. automethod:: jsonrpcclient.client.Client.send

Request class
=============
Expand All @@ -23,7 +23,7 @@ Request class

from jsonrpcclient import Request

.. autoclass:: request.Request
.. autoclass:: jsonrpcclient.request.Request

Send a ``Request`` object::

Expand All @@ -32,7 +32,7 @@ Send a ``Request`` object::
<-- {"jsonrpc": "2.0", "result": "pong", "id": 1}
'pong'

The :func:`~client.Client.request` method is a wrapper around
The :func:`~jsonrpcclient.client.Client.request` method is a wrapper around
``send(Request())``.

If you're not interested in a response, use the ``Notification`` class instead
Expand All @@ -48,7 +48,7 @@ message::
{'jsonrpc': '2.0', 'method': 'cat', 'id': 1}, \
{'jsonrpc': '2.0', 'method': 'dog', 'id': 2}])

Send multiple :class:`~request.Request` objects::
Send multiple :class:`~jsonrpcclient.request.Request` objects::

client.send([Request('cat'), Request('dog')])

Expand All @@ -64,7 +64,7 @@ object - a list of responses for each request that had an ``id`` member.
Configuration
=============

.. automodule:: config
.. automodule:: jsonrpcclient.config

Configuring the Requests library
--------------------------------
Expand All @@ -86,7 +86,7 @@ Custom HTTP headers::
client.session.headers.update({'Content-Type': 'application/json-rpc'})

You can also configure some Requests options when calling
:func:`~client.Client.send`::
:func:`~jsonrpcclient.client.Client.send`::

client.send(req, verify=True, cert='/path/to/certificate', \
headers={'Content-Type': 'application/json-rpc'})
Expand Down
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('../jsonrpcclient'))
sys.path.insert(0, os.path.abspath('..'))

def setup(app):
app.add_stylesheet('custom.css')
Expand Down

0 comments on commit a28bf2b

Please sign in to comment.