Skip to content

Commit 6ef3741

Browse files
igorborgestigorborgest
committed
Add external documentation again
1 parent 51fdbd7 commit 6ef3741

14 files changed

+348
-2
lines changed

‎README.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
* Athena -> Pandas (One shot or Batching)
2020
* PySpark -> Redshift
2121
* Delete S3 objects (parallel :rocket:)
22+
* Encrypt S3 data with KMS keys
2223

2324
## Installation
2425

@@ -146,8 +147,8 @@ session.s3.delete_objects(path="s3://...")
146147

147148
### Pandas to Redshift Flow
148149

149-
![Pandas to Redshift Flow](docs/pandas-to-redshift/pandas-to-redshift-flow.jpg?raw=true "Pandas to Redshift Flow")
150+
![Pandas to Redshift Flow](docs/source/_static/pandas-to-redshift-flow.jpg?raw=true "Pandas to Redshift Flow")
150151

151152
### Spark to Redshift Flow
152153

153-
![Spark to Redshift Flow](docs/spark-to-redshift/spark-to-redshift-flow.jpg?raw=true "Spark to Redshift Flow")
154+
![Spark to Redshift Flow](docs/source/_static/spark-to-redshift-flow.jpg?raw=true "Spark to Redshift Flow")

‎building/build-docs.sh‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#!/bin/bash
2+
3+
cd ..
4+
sphinx-apidoc --separate -f -H "API Reference" -o docs/source/api awswrangler/
5+
make -C docs/ html
6+
cd build
7+
echo DONE!

‎docs/Makefile‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/make.bat‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
13+
if "%1" == "" goto help
14+
15+
%SPHINXBUILD% >NUL 2>NUL
16+
if errorlevel 9009 (
17+
echo.
18+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19+
echo.installed, then set the SPHINXBUILD environment variable to point
20+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
21+
echo.may add the Sphinx directory to PATH.
22+
echo.
23+
echo.If you don't have Sphinx installed, grab it from
24+
echo.http://sphinx-doc.org/
25+
exit /b 1
26+
)
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

‎docs/pandas-to-redshift/pandas-to-redshift-flow.jpg‎ renamed to ‎docs/source/_static/pandas-to-redshift-flow.jpg‎

File renamed without changes.

‎docs/pandas-to-redshift/pandas-to-redshift-flow.xml‎ renamed to ‎docs/source/_static/pandas-to-redshift-flow.xml‎

File renamed without changes.

‎docs/spark-to-redshift/spark-to-redshift-flow.jpg‎ renamed to ‎docs/source/_static/spark-to-redshift-flow.jpg‎

File renamed without changes.

‎docs/spark-to-redshift/spark-to-redshift-flow.xml‎ renamed to ‎docs/source/_static/spark-to-redshift-flow.xml‎

File renamed without changes.

‎docs/source/conf.py‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# This file only contains a selection of the most common options. For a full
4+
# list see the documentation:
5+
# http://www.sphinx-doc.org/en/master/config
6+
7+
# -- Path setup --------------------------------------------------------------
8+
9+
# If extensions (or modules to document with autodoc) are in another directory,
10+
# add these directories to sys.path here. If the directory is relative to the
11+
# documentation root, use os.path.abspath to make it absolute, like shown here.
12+
#
13+
import os
14+
import sys
15+
16+
17+
# Insert awswrangler's path into the system.
18+
sys.path.insert(0, os.path.abspath("../.."))
19+
import awswrangler
20+
21+
22+
# -- Project information -----------------------------------------------------
23+
24+
project = 'AWS Data Wrangler'
25+
author = 'Igor Tavares'
26+
27+
master_doc = 'index'
28+
29+
# The full version, including alpha/beta/rc tags
30+
release = awswrangler.__version__
31+
version = awswrangler.__version__
32+
33+
34+
# -- General configuration ---------------------------------------------------
35+
36+
# Add any Sphinx extension module names here, as strings. They can be
37+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
38+
# ones.
39+
extensions = [
40+
"sphinx.ext.autodoc"
41+
]
42+
43+
language = None
44+
45+
# Add any paths that contain templates here, relative to this directory.
46+
templates_path = ['_templates']
47+
48+
# List of patterns, relative to source directory, that match files and
49+
# directories to ignore when looking for source files.
50+
# This pattern also affects html_static_path and html_extra_path.
51+
exclude_patterns = []
52+
53+
54+
# -- Options for HTML output -------------------------------------------------
55+
56+
# The theme to use for HTML and HTML Help pages. See the documentation for
57+
# a list of builtin themes.
58+
#
59+
html_theme = 'alabaster'
60+
html_show_copyright = False
61+
html_theme_options = {
62+
"show_powered_by": False,
63+
"show_related": False,
64+
"github_user": "awslabs",
65+
"github_repo": "aws-data-wrangler",
66+
"github_banner": True,
67+
"github_button": True,
68+
"github_type": "star"
69+
}
70+
71+
# Add any paths that contain custom static files (such as style sheets) here,
72+
# relative to this directory. They are copied after the builtin static files,
73+
# so a file named "default.css" will overwrite the builtin "default.css".
74+
html_static_path = ['_static']

‎docs/source/divingdeep.rst‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
.. _doc_divingdeep:
2+
3+
Diving Deep
4+
===========
5+
6+
Pandas to Redshift Flow
7+
-----------------------
8+
9+
.. figure:: _static/pandas-to-redshift-flow.jpg
10+
:align: center
11+
:alt: alternate text
12+
:figclass: align-center
13+
14+
Pandas to Redshift Flow
15+
16+
Spark to Redshift Flow
17+
----------------------
18+
19+
.. figure:: _static/spark-to-redshift-flow.jpg
20+
:align: center
21+
:alt: alternate text
22+
:figclass: align-center
23+
24+
Spark to Redshift Flow

0 commit comments

Comments
 (0)