.. Flask-S3-Viewer documentation master file, created by
   sphinx-quickstart on Mon Apr 13 17:07:44 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. meta::
    :description: Flask S3 Viewer is a powerful extension that makes it easy to browse S3 in any Flask application
    :keywords: Flask, s3, aws, upload, uploader, browsing, python3, python, mount, objectstorage, s3viewer

Welcome to Flask-S3-Viewer's documentation!
===========================================
Flask S3 Viewer is a powerful extension that makes it easy to browse S3 in any Flask application. If you are familiar with Flask, Flask S3 Viewer should be easy to pick up.

.. image:: https://raw.githubusercontent.com/hidekuma/flask-s3-viewer/master/i/logo.png
    :width: 200
    :alt: Flask-S3-Viewer-logo

|PyPI version| |Build Status| |Documentation Status| |Maintenance| |made-with-python|

.. toctree::
   :maxdepth: 2
   :caption: Contents:

    Installation <usage/installation>
    Configuration <usage/configuration>
    Reference <reference>
    Templates <usage/templates>
    License <license>
    Changelog <changelog>

Indices and tables
------------------
* :ref:`modindex`

.. * :ref:`genindex`

.. * :ref:`search`

Useful links
------------
    * `Flask S3Viewer @ Github`_
    * `Flask S3Viewer @ PyPi`_

Show video on youtube:

|flask-s3-viewer-video|


.. |PyPI version| image:: https://badge.fury.io/py/flask-s3-viewer.svg
   :target: https://badge.fury.io/py/flask-s3-viewer
.. |Build Status| image:: https://travis-ci.org/hidekuma/flask-s3-viewer.svg?branch=master
   :target: https://travis-ci.org/hidekuma/flask-s3-viewer
.. |Documentation Status| image:: https://readthedocs.org/projects/flask-s3-viewer/badge/?version=latest
    :target: https://flask-s3-viewer.readthedocs.io/en/latest/?badge=latest
.. |Maintenance| image:: https://img.shields.io/badge/Maintained%3F-yes-green.svg
   :target: https://github.com/hidekuma/flask-s3-viewer/graphs/commit-activity
.. |made-with-python| image:: https://img.shields.io/badge/Made%20with-Python-1f425f.svg
   :target: https://www.python.org/
.. |flask-s3-viewer-video| image:: http://img.youtube.com/vi/MPFo1scGlws/0.jpg
   :target: https://youtu.be/MPFo1scGlws?t=0s
.. _Flask S3Viewer @ Github: https://github.com/hidekuma/flask-s3-viewer
.. _Flask S3Viewer @ PyPi: https://pypi.org/project/flask-s3-viewer