Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hidekuma committed Apr 14, 2020
1 parent a16a48e commit de51365
Show file tree
Hide file tree
Showing 11 changed files with 464 additions and 11 deletions.
File renamed without changes.
35 changes: 35 additions & 0 deletions docs/make.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build

if "%1" == "" goto help

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

:end
popd
62 changes: 62 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys
sys.path.insert(0, os.path.abspath('../..'))
from flask_s3up import __version__ as VERSION



# -- Project information -----------------------------------------------------

project = 'Flask-S3Up'
copyright = '2020, hidekuma'
author = 'hidekuma'

# The full version, including alpha/beta/rc tags
release = VERSION


# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'recommonmark'
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_scaled_image_link = False

# -- Extension configuration -------------------------------------------------
46 changes: 46 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
.. Flask-S3Up 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: The Sphinx documentation builder
:keywords: Sphinx, documentation, builder


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

.. image:: https://raw.githubusercontent.com/hidekuma/flask-s3up/master/i/logo.png
:width: 200
:alt: Flask-S3Up-logo

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

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

Installation <usage/installation>
Quick start <usage/quickstart>
Controll Templates <usage/templates>
License <https://github.com/hidekuma/flask-s3up/blob/master/LICENSE>

.. * :ref:`modindex`
.. * :ref:`search`
Show video on youtube:

|flask-s3up-video|

.. |PyPI version| image:: https://badge.fury.io/py/flask-s3up.svg
:target: https://badge.fury.io/py/flask-s3up
.. |Build Status| image:: https://travis-ci.org/hidekuma/flask-s3up.svg?branch=master
:target: https://travis-ci.org/hidekuma/flask-s3up
.. |Maintenance| image:: https://img.shields.io/badge/Maintained%3F-yes-green.svg
:target: https://github.com/hidekuma/flask-s3up/graphs/commit-activity
.. |made-with-python| image:: https://img.shields.io/badge/Made%20with-Python-1f425f.svg
:target: https://www.python.org/
.. |flask-s3up-video| image:: http://img.youtube.com/vi/yk6h6ym6Diw/0.jpg
:target: https://youtu.be/yk6h6ym6Diw?t=0s
24 changes: 24 additions & 0 deletions docs/source/usage/installation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Installation
============
You can `download FlaskS3Up executable`_ and `binary distributions from PyPI`_

.. _download FlaskS3Up executable: https://github.com/hidekuma/flask-s3up/releases
.. _binary distributions from PyPI: https://pypi.org/project/flask-s3up/

Support versions
----------------------------------------

======= ====== ========
Type Name Version
======= ====== ========
Runtime Python >=3.7
Library boto3 >=1.12.2
Library click >=7.1.1
Library Flask >=1.1.1
======= ====== ========

Using pip
---------
.. code-block:: bash
pip install flask_s3up

0 comments on commit de51365

Please sign in to comment.