diff --git a/.gitignore b/.gitignore index ee250af..1084afa 100644 --- a/.gitignore +++ b/.gitignore @@ -52,8 +52,9 @@ coverage.xml # Django stuff: *.log -# Sphinx documentation -docs/_build/ +# Documentation +docs/_site/ +docs/.jekyll-metadata # PyBuilder target/ diff --git a/.travis.yml b/.travis.yml index e2a9073..7e48103 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,22 +1,40 @@ language: python -python: - - "2.7" - - "3.3" - - "3.4" - - "3.5" - - "pypy" -# command to install dependencies +sudo: required +cache: pip + install: - - "pip install -e ." - - "pip install pep8" -# command to run tests +- pip install -e . +- pip install pycodestyle +- sudo apt-get update +- sudo apt-get install ruby +- gem install bundle +- gem install jeykll +- bundle install +# - pip install mkdocs +# - pip install pymdown-extensions +# - chmod +x ./deploy-docs.sh + +matrix: + include: + - os: linux + python: 2.7 + - os: linux + python: 3.3 + - os: linux + python: 3.4 + - os: linux + env: BUILD_DOCS="true" + python: 3.5 + - os: linux + python: pypy + script: - # Tests - - python setup.py test - # pep8 - - pep8 . - # Examples - - (cd "samples/replicate-workbook" && python replicate_workbook.py) - - (cd "samples/list-tds-info" && python list_tds_info.py) - - (cd "samples/show-fields" && python show_fields.py) +- python setup.py test +- pycodestyle . +- (cd "samples/replicate-workbook" && python replicate_workbook.py) +- (cd "samples/list-tds-info" && python list_tds_info.py) +- (cd "samples/show-fields" && python show_fields.py) +# - bundle exec jekyll build +# after_success: +# - bash deploy-docs.sh diff --git a/CHANGELOG.md b/CHANGELOG.md index 7ba40cd..b53abc0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## 0.4 (07 October 2016) + +* Add ability to remove repository location (#86) +* Fixed bug in connection parsing when federated connections are present (#87) +* Fixed bug in UNICODE support (#80) + ## 0.3 (31 August 2016) * Added basic connection class retargeting (#65) diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md new file mode 100644 index 0000000..d79e152 --- /dev/null +++ b/CONTRIBUTORS.md @@ -0,0 +1,14 @@ +This project wouldn't be possible without our amazing contributors. + +The following people have contributed to this project to make it possible, and we thank them for their contributions! + +## Contributors + +* [Charley Peng](https://github.com/chid) +* [Miguel Sánchez](https://github.com/MiguelSR) + +## Core Team + +* [Tyler Doyle](https://github.com/t8y8) +* [Russell Hay](https://github.com/RussTheAerialist) + diff --git a/contributing.md b/contributing.md index 15fc5f8..ef54847 100644 --- a/contributing.md +++ b/contributing.md @@ -1,4 +1,7 @@ -# Contributing +--- +title: Contributing +layout: docs +--- We welcome contributions to this project! diff --git a/deploy-docs.sh b/deploy-docs.sh new file mode 100644 index 0000000..b7e5a14 --- /dev/null +++ b/deploy-docs.sh @@ -0,0 +1,28 @@ +#!/bin/bash + +set -o errexit -o nounset + +if [ "$TRAVIS_BRANCH" != "master" -o "$BUILD_DOCS" != "true" ] +then + echo "Not deploying docs" + exit 0 +fi + +rev=$(git rev-parse --short HEAD) + +cd site + +git init +git config user.name "T8y8" +git config user.email "kingt8y8@gmail.com" + + +git remote add upstream "https://$GH_TOKEN@github.com/t8y8/document-api-python.git" +git fetch upstream +git reset upstream/gh-pages + +touch . + +git add -A . +git commit -m "auto-build rebuild pages at ${rev}" +git push -q upstream HEAD:gh-pages diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 0000000..775d954 --- /dev/null +++ b/docs/Gemfile @@ -0,0 +1,3 @@ +source 'https://rubygems.org' +gem 'github-pages', group: :jekyll_plugins + diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock new file mode 100644 index 0000000..e555d12 --- /dev/null +++ b/docs/Gemfile.lock @@ -0,0 +1,129 @@ +GEM + remote: https://rubygems.org/ + specs: + activesupport (4.2.6) + i18n (~> 0.7) + json (~> 1.7, >= 1.7.7) + minitest (~> 5.1) + thread_safe (~> 0.3, >= 0.3.4) + tzinfo (~> 1.1) + addressable (2.4.0) + coffee-script (2.4.1) + coffee-script-source + execjs + coffee-script-source (1.10.0) + colorator (0.1) + ethon (0.9.0) + ffi (>= 1.3.0) + execjs (2.7.0) + faraday (0.9.2) + multipart-post (>= 1.2, < 3) + ffi (1.9.10) + ffi (1.9.10-x86-mingw32) + gemoji (2.1.0) + github-pages (80) + github-pages-health-check (= 1.1.0) + jekyll (= 3.1.6) + jekyll-coffeescript (= 1.0.1) + jekyll-feed (= 0.5.1) + jekyll-gist (= 1.4.0) + jekyll-github-metadata (= 1.11.1) + jekyll-mentions (= 1.1.2) + jekyll-paginate (= 1.1.0) + jekyll-redirect-from (= 0.10.0) + jekyll-sass-converter (= 1.3.0) + jekyll-seo-tag (= 1.4.0) + jekyll-sitemap (= 0.10.0) + jemoji (= 0.6.2) + kramdown (= 1.10.0) + liquid (= 3.0.6) + listen (= 3.0.6) + mercenary (~> 0.3) + rouge (= 1.10.1) + terminal-table (~> 1.4) + github-pages-health-check (1.1.0) + addressable (~> 2.3) + net-dns (~> 0.8) + octokit (~> 4.0) + public_suffix (~> 1.4) + typhoeus (~> 0.7) + html-pipeline (2.4.1) + activesupport (>= 2, < 5) + nokogiri (>= 1.4) + i18n (0.7.0) + jekyll (3.1.6) + colorator (~> 0.1) + jekyll-sass-converter (~> 1.0) + jekyll-watch (~> 1.1) + kramdown (~> 1.3) + liquid (~> 3.0) + mercenary (~> 0.3.3) + rouge (~> 1.7) + safe_yaml (~> 1.0) + jekyll-coffeescript (1.0.1) + coffee-script (~> 2.2) + jekyll-feed (0.5.1) + jekyll-gist (1.4.0) + octokit (~> 4.2) + jekyll-github-metadata (1.11.1) + octokit (~> 4.0) + jekyll-mentions (1.1.2) + html-pipeline (~> 2.3) + jekyll (~> 3.0) + jekyll-paginate (1.1.0) + jekyll-redirect-from (0.10.0) + jekyll (>= 2.0) + jekyll-sass-converter (1.3.0) + sass (~> 3.2) + jekyll-seo-tag (1.4.0) + jekyll (~> 3.0) + jekyll-sitemap (0.10.0) + jekyll-watch (1.4.0) + listen (~> 3.0, < 3.1) + jemoji (0.6.2) + gemoji (~> 2.0) + html-pipeline (~> 2.2) + jekyll (>= 3.0) + json (1.8.3) + kramdown (1.10.0) + liquid (3.0.6) + listen (3.0.6) + rb-fsevent (>= 0.9.3) + rb-inotify (>= 0.9.7) + mercenary (0.3.6) + mini_portile2 (2.0.0) + minitest (5.9.0) + multipart-post (2.0.0) + net-dns (0.8.0) + nokogiri (1.6.7.2) + mini_portile2 (~> 2.0.0.rc2) + nokogiri (1.6.7.2-x86-mingw32) + mini_portile2 (~> 2.0.0.rc2) + octokit (4.3.0) + sawyer (~> 0.7.0, >= 0.5.3) + public_suffix (1.5.3) + rb-fsevent (0.9.7) + rb-inotify (0.9.7) + ffi (>= 0.5.0) + rouge (1.10.1) + safe_yaml (1.0.4) + sass (3.4.22) + sawyer (0.7.0) + addressable (>= 2.3.5, < 2.5) + faraday (~> 0.8, < 0.10) + terminal-table (1.5.2) + thread_safe (0.3.5) + typhoeus (0.8.0) + ethon (>= 0.8.0) + tzinfo (1.2.2) + thread_safe (~> 0.1) + +PLATFORMS + ruby + x86-mingw32 + +DEPENDENCIES + github-pages + +BUNDLED WITH + 1.12.5 diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000..1a4c913 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,17 @@ +# Site settings +title: Tableau Document API +email: jdominguez@tableau.com +description: Programmatically update your Tableau workbooks and data sources. +baseurl: "/document-api-python" +permalinks: pretty +defaults: + - + scope: + path: "" # Apply to all files + values: + layout: "default" + +# Build settings +markdown: kramdown +highlighter: rouge + diff --git a/docs/_includes/docs_menu.html b/docs/_includes/docs_menu.html new file mode 100644 index 0000000..b7a76d5 --- /dev/null +++ b/docs/_includes/docs_menu.html @@ -0,0 +1,16 @@ +
+ +
diff --git a/docs/_includes/footer.html b/docs/_includes/footer.html new file mode 100644 index 0000000..5cae7ea --- /dev/null +++ b/docs/_includes/footer.html @@ -0,0 +1,8 @@ + + diff --git a/docs/_includes/head.html b/docs/_includes/head.html new file mode 100644 index 0000000..288d960 --- /dev/null +++ b/docs/_includes/head.html @@ -0,0 +1,15 @@ + + + + + {% if page.title %}{{ page.title | escape }}{% else %}{{ site.title | escape }}{% endif %} + + + + + + + + + + diff --git a/docs/_includes/header.html b/docs/_includes/header.html new file mode 100644 index 0000000..cad2487 --- /dev/null +++ b/docs/_includes/header.html @@ -0,0 +1,29 @@ +
+
+ +
+
diff --git a/docs/_includes/icon-github.svg b/docs/_includes/icon-github.svg new file mode 100644 index 0000000..4422c4f --- /dev/null +++ b/docs/_includes/icon-github.svg @@ -0,0 +1 @@ + diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html new file mode 100644 index 0000000..38ee020 --- /dev/null +++ b/docs/_layouts/default.html @@ -0,0 +1,34 @@ + + + + + {% include head.html %} + + + +
+ {% include header.html %} + + {% include footer.html %} +
+ + + diff --git a/docs/_layouts/docs.html b/docs/_layouts/docs.html new file mode 100644 index 0000000..1269e39 --- /dev/null +++ b/docs/_layouts/docs.html @@ -0,0 +1,31 @@ +--- +layout: docs +--- + + + + + + {% include head.html %} + + + +
+ {% include header.html %} + {% include docs_menu.html %} + +
+

{{ page.title }}

+
+ Edit this page +   + Submit an issue +
+
+ {{ content }} + {% include footer.html %} +
+
+ + + diff --git a/docs/_layouts/home.html b/docs/_layouts/home.html new file mode 100644 index 0000000..c2cf32f --- /dev/null +++ b/docs/_layouts/home.html @@ -0,0 +1,19 @@ +--- +layout: home +--- + + + + + {% include head.html %} + + + +
+ {% include header.html %} + {{ content }} + {% include footer.html %} +
+ + + diff --git a/docs/assets/logo.png b/docs/assets/logo.png new file mode 100644 index 0000000..6076115 Binary files /dev/null and b/docs/assets/logo.png differ diff --git a/docs/css/api_ref.css b/docs/css/api_ref.css new file mode 100644 index 0000000..62da935 --- /dev/null +++ b/docs/css/api_ref.css @@ -0,0 +1,709 @@ +