diff --git a/.gitignore b/.gitignore index b3b3ff80f..80de37e58 100644 --- a/.gitignore +++ b/.gitignore @@ -157,3 +157,154 @@ docs/.jekyll-metadata docs/Gemfile.lock samples/credentials .venv/ +||||||| empty tree +======= +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +env/ +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +*.egg-info/ +.installed.cfg +*.egg + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*,cover +.hypothesis/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# PyCharm stuff +.idea/ + +# IPython Notebook +.ipynb_checkpoints + +# pyenv +.python-version + +# celery beat schedule file +celerybeat-schedule + +# dotenv +.env + +# virtualenv +venv/ +ENV/ + +# Spyder project settings +.spyderproject + +# Rope project settings +.ropeproject + +.vscode/ + +# macOS.gitignore from https://github.com/github/gitignore +*.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + + + +# Windows.gitignore from https://github.com/github/gitignore +# Windows image file caches +Thumbs.db +ehthumbs.db + +# Folder config file +Desktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msm +*.msp + +# Windows shortcuts +*.lnk + +# Documentation +_site/ +.jekyll-metadata +Gemfile.lock diff --git a/Gemfile b/Gemfile new file mode 100644 index 000000000..37f5eaa42 --- /dev/null +++ b/Gemfile @@ -0,0 +1,2 @@ +source 'https://rubygems.org' +gem 'github-pages', group: :jekyll_plugins diff --git a/README.md b/README.md index 5c80f337e..f578d30a5 100644 --- a/README.md +++ b/README.md @@ -20,3 +20,10 @@ To contribute, see our [Developer Guide](https://tableau.github.io/server-client ## License [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ftableau%2Fserver-client-python.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Ftableau%2Fserver-client-python?ref=badge_large) +||||||| empty tree +======= +# Tableau Server Client - Documentation + +This is the documentation branch. + +Refer to the [Developer Guide](https://tableau.github.io/server-client-python/docs/dev-guide) for information on making changes or view the [published docs](https://tableau.github.io/server-client-python/) to see the final output. diff --git a/_config.yml b/_config.yml new file mode 100644 index 000000000..5ea15f228 --- /dev/null +++ b/_config.yml @@ -0,0 +1,17 @@ +# Site settings +title: Tableau Server Client Library (Python) +email: github@tableau.com +description: Simplify interactions with the Tableau Server REST API. +baseurl: "/server-client-python" +permalinks: pretty +defaults: + - + scope: + path: "" # Apply to all files + values: + layout: "default" + +# Build settings +markdown: kramdown +highlighter: rouge + diff --git a/_includes/analytics.html b/_includes/analytics.html new file mode 100644 index 000000000..0cdbad25d --- /dev/null +++ b/_includes/analytics.html @@ -0,0 +1,7 @@ + + + diff --git a/_includes/docs_menu.html b/_includes/docs_menu.html new file mode 100644 index 000000000..8f1db8880 --- /dev/null +++ b/_includes/docs_menu.html @@ -0,0 +1,96 @@ +
+ {% include search_form.html %} + +
diff --git a/_includes/footer.html b/_includes/footer.html new file mode 100644 index 000000000..f3c168ed2 --- /dev/null +++ b/_includes/footer.html @@ -0,0 +1,9 @@ + + diff --git a/_includes/head.html b/_includes/head.html new file mode 100644 index 000000000..1321285cf --- /dev/null +++ b/_includes/head.html @@ -0,0 +1,18 @@ + + + + + {% if page.title %}{{ page.title | escape }}{% else %}{{ site.title | escape }}{% endif %} + + + + + + + + + + + + +{% if jekyll.environment == "production" %}{% include analytics.html %}{% endif %} diff --git a/_includes/header.html b/_includes/header.html new file mode 100644 index 000000000..b8ad08f65 --- /dev/null +++ b/_includes/header.html @@ -0,0 +1,29 @@ +
+
+ +
+
diff --git a/_includes/icon-github.svg b/_includes/icon-github.svg new file mode 100644 index 000000000..4422c4f5d --- /dev/null +++ b/_includes/icon-github.svg @@ -0,0 +1 @@ + diff --git a/_includes/search_form.html b/_includes/search_form.html new file mode 100644 index 000000000..41bb34259 --- /dev/null +++ b/_includes/search_form.html @@ -0,0 +1,7 @@ +
+ +
+ diff --git a/_layouts/default.html b/_layouts/default.html new file mode 100644 index 000000000..38ee020bb --- /dev/null +++ b/_layouts/default.html @@ -0,0 +1,34 @@ + + + + + {% include head.html %} + + + +
+ {% include header.html %} + + {% include footer.html %} +
+ + + diff --git a/_layouts/docs.html b/_layouts/docs.html new file mode 100644 index 000000000..d40bafbdf --- /dev/null +++ b/_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/_layouts/home.html b/_layouts/home.html new file mode 100644 index 000000000..c2cf32fcb --- /dev/null +++ b/_layouts/home.html @@ -0,0 +1,19 @@ +--- +layout: home +--- + + + + + {% include head.html %} + + + +
+ {% include header.html %} + {{ content }} + {% include footer.html %} +
+ + + diff --git a/_layouts/search.html b/_layouts/search.html new file mode 100644 index 000000000..96dbd94a1 --- /dev/null +++ b/_layouts/search.html @@ -0,0 +1,43 @@ +--- +layout: search +--- + + + + + + {% include head.html %} + + + + + + + +
+ {% include header.html %} + {% include docs_menu.html %} + +
+

+
+
+

Loading search results...

+
+ + {% include footer.html %} +
+
+ + diff --git a/assets/fiddler.png b/assets/fiddler.png new file mode 100644 index 000000000..cb5fde8e6 Binary files /dev/null and b/assets/fiddler.png differ diff --git a/assets/logo.png b/assets/logo.png new file mode 100644 index 000000000..607611521 Binary files /dev/null and b/assets/logo.png differ diff --git a/css/api_ref.css b/css/api_ref.css new file mode 100644 index 000000000..62da93510 --- /dev/null +++ b/css/api_ref.css @@ -0,0 +1,709 @@ +