diff --git a/.gitignore b/.gitignore index ee250af..0b50f47 100644 --- a/.gitignore +++ b/.gitignore @@ -64,3 +64,6 @@ target/ #Other things .DS_Store .idea + +#Jekyll +docs/_site diff --git a/.travis.yml b/.travis.yml index e2a9073..32f39d0 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,4 +1,6 @@ language: python +cache: pip + python: - "2.7" - "3.3" 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 deleted file mode 100644 index 15fc5f8..0000000 --- a/contributing.md +++ /dev/null @@ -1,33 +0,0 @@ -# Contributing - -We welcome contributions to this project! - -Contribution can include, but are not limited to, any of the following: - -* File an Issue -* Request a Feature -* Implement a Requested Feature -* Fix an Issue/Bug -* Add/Fix documentation - -Contributions must follow the guidelines outlined on the [Tableau Organization](http://tableau.github.io/) page, though filing an issue or requesting -a feature do not require the CLA. - -## Issues and Feature Requests - -To submit an issue/bug report, or to request a feature, please submit a [github issue](https://github.com/tableau/document-api-python/issues) to the repo. - -If you are submiting a bug report, please provide as much information as you can, including clear and concise repro steps, attaching any necessary -files to assist in the repro. **Be sure to scrub the files of any potentially sensitive information. Issues are public.** - -For a feature request, please try to describe the scenario you are trying to accomplish that requires the feature. This will help us understand -the limitations that you are running into, and provide us with a use case to know if we've satisfied your request. - -## Fixes, Implementations, and Documentation - -For all other things, please submit a PR that includes the fix, documentation, or new code that you are trying to contribute. More information on -creating a PR can be found in the [github documentation](https://help.github.com/articles/creating-a-pull-request/) - -If the feature is complex or has multiple solutions that could be equally appropriate approaches, it would be helpful to file an issue to discuss the -design trade-offs of each solution before implementing, to allow us to collectively arrive at the best solution, which most likely exists in the middle -somewhere. diff --git a/contributing.md b/contributing.md new file mode 120000 index 0000000..e047e03 --- /dev/null +++ b/contributing.md @@ -0,0 +1 @@ +docs/docs/contributing.md \ No newline at end of file diff --git a/docs/.keep b/docs/.keep new file mode 100644 index 0000000..4e4b8f1 --- /dev/null +++ b/docs/.keep @@ -0,0 +1 @@ +Hello docs! \ No newline at end of file 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..5fefbee --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,17 @@ +# Site settings +title: Tableau Document API +email: github@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..d229de4 --- /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 @@ +