Skip to content

Commit

Permalink
readthedocs: Install the requirements with the 'docs' extra
Browse files Browse the repository at this point in the history
  • Loading branch information
cipres committed Apr 11, 2024
1 parent 28f83e3 commit 81c2b79
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 3 deletions.
6 changes: 4 additions & 2 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,7 @@ build:

python:
install:
- requirements: requirements.txt
- requirements: requirements-docs.txt
- method: pip
path: .
extra_requirements:
- docs
9 changes: 9 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,15 @@ Otherwise just pass *host* and *port* separately:
client = aioipfs.AsyncIPFS(host='::1', port=5201)
If the kubo server requires authentication, you can pass the RPC authentication
credentials via the constructor's *auth* keyword argument:

.. code-block:: python
client = aioipfs.AsyncIPFS(auth=aioipfs.BasicAuth('john', 'password123'))
client = aioipfs.AsyncIPFS(auth=aioipfs.BearerAuth('my-secret-token'))
Get an IPFS resource
--------------------

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ of the RPC API by requiring the client to provide credentials via the HTTP
*Authorization* header, either with a simple *Basic Auth* login and password, or
with a token. `kubo RPC Authorization documentation <https://github.com/ipfs/kubo/blob/master/docs/config.md#apiauthorizations>`_.

If the kubo server requires authentication, you can pass the authentication
If the kubo server requires authentication, you can pass the RPC authentication
credentials via the constructor's *auth* keyword argument::

client = aioipfs.AsyncIPFS(auth=aioipfs.BasicAuth('john', 'password123'))
Expand Down

0 comments on commit 81c2b79

Please sign in to comment.