MNT rebuild website

gallantlab · Apr 4, 2023 · 86a9b42 · 86a9b42
1 parent fcb2727
commit 86a9b42
Show file tree

Hide file tree

Showing 91 changed files with 5,226 additions and 2,912 deletions.
diff --git a/docs/_sources/api/cottoncandy.localclient.rst.txt b/docs/_sources/api/cottoncandy.localclient.rst.txt
@@ -0,0 +1,32 @@
+.. AUTO-GENERATED FILE -- DO NOT EDIT!
+
+:mod:`localclient`
+==================
+.. automodule:: cottoncandy.localclient
+
+.. currentmodule:: cottoncandy.localclient
+.. autosummary::
+
+   LocalClient
+   auto_makedirs
+
+
+.. currentmodule:: cottoncandy.localclient
+
+
+:class:`LocalClient`
+~~~~~~~~~~~~~~~~~~~~
+
+
+.. autoclass:: LocalClient
+  :members:
+  :undoc-members:
+  :show-inheritance:
+
+  .. automethod:: __init__
+
+auto_makedirs
+~~~~~~~~~~~~~
+
+.. autofunction:: auto_makedirs
+
diff --git a/docs/_sources/api/index.rst.txt b/docs/_sources/api/index.rst.txt
@@ -12,6 +12,7 @@ API Reference
    cottoncandy.browser.rst
    cottoncandy.gdriveclient.rst
    cottoncandy.interfaces.rst
+   cottoncandy.localclient.rst
    cottoncandy.options.rst
    cottoncandy.s3client.rst
    cottoncandy.utils.rst
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -25,6 +25,12 @@ Clone the repo from GitHub and do the usual python install
    cd cottoncandy
    sudo python setup.py install
 
+or install from PyPI
+
+::
+
+   pip install cottoncandy
+
 A configuration file will be saved under ``~/.config/cottoncandy/options.cfg``. Upon installation cottoncandy will try to find your AWS keys and store them in this file. See the `default file <https://github.com/gallantlab/cottoncandy/blob/main/cottoncandy/defaults.cfg>`_ for more configuration options.
 
 Object and bucket permissions are set to ``authenticated-read`` by default. If you wish to keep all your objects private, modify the configuration file and set ``default_acl = private``. See `AWS ACL overview <http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html>`_ for more information on S3 permissions.