diff --git a/doc/api.rst b/doc/api.rst index 084984df..366a2192 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -17,21 +17,21 @@ exasol.bucketfs.Bucket :show-inheritance: exasol.bucketfs.SaaSBucket ------------------------ +-------------------------- .. autoclass:: exasol.bucketfs.Bucket :members: :undoc-members: :show-inheritance: exasol.bucketfs.path.PathLike ------------------------ +----------------------------- .. autoclass:: exasol.bucketfs.path.PathLike :members: :undoc-members: :show-inheritance: exasol.bucketfs.path.build_path ------------------------- +------------------------------- .. autofunction:: exasol.bucketfs.path.build_path exasol.bucketfs.as_bytes diff --git a/doc/user_guide/basics.rst b/doc/user_guide/basics.rst index aad22a0e..95327ca0 100644 --- a/doc/user_guide/basics.rst +++ b/doc/user_guide/basics.rst @@ -23,7 +23,7 @@ Get a Bucket reference Bucket class -------------- +------------ A Bucket contains a set of files which may be restricted, depending on the credentials of the requester. The Bucket class for an On-Prem database is :ref:`exasol.bucketfs.Bucket `. The correspondent class for a SaaS database is :ref:`exasol.bucketfs.Bucket `. @@ -80,17 +80,17 @@ Delete files from Bucket :end-before: # Expert/Mapped bucket API Create bucket object in SaaS -++++++++++++++++++++++++ +++++++++++++++++++++++++++++ .. literalinclude:: /examples/bucket_saas.py :language: python3 PathLike interface -------------- +------------------ A PathLike is an interface similar to the pathlib.Path and should feel familiar to most users. Using the PathLike interface -++++++++++++++++++++++++ +++++++++++++++++++++++++++++ .. literalinclude:: /examples/path_like.py :language: python3