Skip to content

Commit c2d924d

Browse files
authored
add rst links to API (#752)
1 parent 47d1fa9 commit c2d924d

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/source/index.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@ S3Fs
33

44
S3Fs is a Pythonic file interface to S3. It builds on top of botocore_.
55

6-
The top-level class ``S3FileSystem`` holds connection information and allows
6+
The top-level class :py:class:`.S3FileSystem` holds connection information and allows
77
typical file-system style operations like ``cp``, ``mv``, ``ls``, ``du``,
88
``glob``, etc., as well as put/get of local files to/from S3.
99

1010
The connection can be anonymous - in which case only publicly-available,
1111
read-only buckets are accessible - or via credentials explicitly supplied
1212
or in configuration files.
1313

14-
Calling ``open()`` on a ``S3FileSystem`` (typically using a context manager)
15-
provides an ``S3File`` for read or write access to a particular key. The object
14+
Calling ``open()`` on a :py:class:`.S3FileSystem` (typically using a context manager)
15+
provides an :py:class:`.S3File` for read or write access to a particular key. The object
1616
emulates the standard ``File`` protocol (``read``, ``write``, ``tell``,
1717
``seek``), such that functions expecting a file can access S3. Only binary read
1818
and write modes are implemented, with blocked caching.
@@ -72,7 +72,7 @@ Integration
7272
The libraries ``intake``, ``pandas`` and ``dask`` accept URLs with the prefix
7373
"s3://", and will use s3fs to complete the IO operation in question. The
7474
IO functions take an argument ``storage_options``, which will be passed
75-
to ``S3FileSystem``, for example:
75+
to :py:class:`.S3FileSystem`, for example:
7676

7777
.. code-block:: python
7878
@@ -87,7 +87,7 @@ Async
8787
-----
8888

8989
``s3fs`` is implemented using ``aiobotocore``, and offers async functionality.
90-
A number of methods of ``S3FileSystem`` are ``async``, for for each of these,
90+
A number of methods of :py:class:`.S3FileSystem` are ``async``, for for each of these,
9191
there is also a synchronous version with the same name and lack of a ``_``
9292
prefix.
9393

@@ -153,7 +153,7 @@ Python's standard `logging framework`_.
153153
Credentials
154154
-----------
155155

156-
The AWS key and secret may be provided explicitly when creating an ``S3FileSystem``.
156+
The AWS key and secret may be provided explicitly when creating an :py:class:`.S3FileSystem`.
157157
A more secure way, not including the credentials directly in code, is to allow
158158
boto to establish the credentials automatically. Boto will try the following
159159
methods, in order:
@@ -165,22 +165,22 @@ methods, in order:
165165

166166
- for nodes on EC2, the IAM metadata provider
167167

168-
You can specify a profile using `s3fs.S3FileSystem(profile='PROFILE')`.
168+
You can specify a profile using ``s3fs.S3FileSystem(profile='PROFILE')``.
169169
Otherwise ``sf3s`` will use authentication via `boto environment variables`_.
170170

171171
.. _boto environment variables: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#using-environment-variables
172172

173173
In a distributed environment, it is not expected that raw credentials should
174174
be passed between machines. In the explicitly provided credentials case, the
175-
method ``get_delegated_s3pars()`` can be used to obtain temporary credentials.
175+
method :py:meth:`.S3FileSystem.get_delegated_s3pars` can be used to obtain temporary credentials.
176176
When not using explicit credentials, it should be expected that every machine
177177
also has the appropriate environment variables, config files or IAM roles
178178
available.
179179

180180
If none of the credential methods are available, only anonymous access will
181181
work, and ``anon=True`` must be passed to the constructor.
182182

183-
Furthermore, ``S3FileSystem.current()`` will return the most-recently created
183+
Furthermore, :py:meth:`.S3FileSystem.current` will return the most-recently created
184184
instance, so this method could be used in preference to the constructor in
185185
cases where the code must be agnostic of the credentials/config used.
186186

@@ -207,7 +207,7 @@ For a self-hosted MinIO instance:
207207
endpoint_url='https://...'
208208
)
209209
210-
It is also possible to set credentials through envrironment variables:
210+
It is also possible to set credentials through environment variables:
211211

212212
.. code-block:: python
213213

0 commit comments

Comments
 (0)