Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/gh-pages' into jorwoods/docs_m…
Browse files Browse the repository at this point in the history 
…erge
  • Loading branch information
@jorwoods
jorwoods committed Nov 17, 2024
2 parents 3460528 + 508a981 commit 89dc05c
Show file tree
Hide file tree
Showing 38 changed files with 8,966 additions and 0 deletions.
151 changes: 151 additions & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 2 additions & 0 deletions Gemfile
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
source 'https://rubygems.org'
gem 'github-pages', group: :jekyll_plugins
7 changes: 7 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
17 changes: 17 additions & 0 deletions _config.yml
View file
Original file line number Diff line number Diff line change
@@ -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

7 changes: 7 additions & 0 deletions _includes/analytics.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<!-- Google Tag Manager -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-BVCN');</script>
<!-- End Google Tag Manager -->
96 changes: 96 additions & 0 deletions _includes/docs_menu.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
<div class="well docs-menu col-xs-12 col-sm-4 col-md-3">
{% include search_form.html %}
<ul class="nav nav-list">
<li>
<a href="{{ site.baseurl }}/docs">Get Started</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/getting-help">Getting Help</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/sign-in-out">Sign In and Out</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/versions">Versions</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/page-through-results">Page Through Results</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/populate-connections-views">Populate Connections and Views</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/filter-sort">Filter and Sort</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/environment-variables">Environment Variables</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/samples">Samples</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/troubleshooting">Troubleshooting</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/dev-guide">Developer Guide</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/api-ref">API Reference</a>
<ul>
<li>
<a href="{{ site.baseurl }}/docs/api-ref#authentication">Authentication</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/api-ref#connections">Connections</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/api-ref#data-sources">Data sources</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/api-ref#filters">Filters</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/api-ref#groups">Groups</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/api-ref#jobs">Jobs</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/api-ref#projects">Projects</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/api-ref#requests">Requests</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/api-ref#schedules">Schedules</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/api-ref#server">Server</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/api-ref#sites">Sites</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/api-ref#sort">Sort</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/api-ref#subscriptions">Subscriptions</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/api-ref#tasks">Tasks</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/api-ref#users">Users</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/api-ref#views">Views</a>
<li>
<a href="{{ site.baseurl }}/docs/api-ref#webhooks">Webhooks</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/api-ref#workbooks">Workbooks</a>
</li>
</ul>
</li>
</ul>
</div>
9 changes: 9 additions & 0 deletions _includes/footer.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<!-- Footer -->
<footer>
<div class="row">
<hr class="footer-hr">
<p>This site is open source. Suggestions and pull requests are welcome on our <a href="https://github.com/tableau/server-client-python">GitHub page</a>.</p>
<p><a href="https://www.tableau.com/en-us/legal" class="aLegal">LEGAL</a> <a href="https://www.tableau.com/en-us/privacy" class="aLegal">PRIVACY</a> &copy; <script>document.write(new Date().getFullYear())</script> Salesforce, Inc.</p>
<sub>Documentation last generated on: {{ site.time }}</sub>
</div>
</footer>
18 changes: 18 additions & 0 deletions _includes/head.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">

<title>{% if page.title %}{{ page.title | escape }}{% else %}{{ site.title | escape }}{% endif %}</title>
<meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">

<link rel="shortcut icon" type="image/png" href="{{ site.baseurl }}/assets/logo.png">

<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.4.1/css/bootstrap.min.css">
<link rel="stylesheet" href="{{ site.baseurl }}/css/main.css">
<link rel="stylesheet" href="{{ site.baseurl }}/css/github-highlight.css">

<script src="{{ site.baseurl }}/js/redirect-to-search.js"></script>
<script src="https://code.jquery.com/jquery-2.2.4.min.js"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.4.1/js/bootstrap.min.js"></script>

{% if jekyll.environment == "production" %}{% include analytics.html %}{% endif %}
29 changes: 29 additions & 0 deletions _includes/header.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<header class="site-header">
<div class="wrapper">
<nav class="navbar navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand navbar-brand-logo" href="{{ site.baseurl }}/#">Tableau Server Client (Python)</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li><a href="{{ site.baseurl }}/docs/">Docs</a></li>
<li><a href="{{ site.baseurl }}/docs/api-ref">API Reference</a></li>
<li><a target="_blank" href="https://community.tableau.com/s/developers">Forum</a></li>
<!-- <li><a href="{{ site.baseurl }}/news/">What's New?</a></li> -->
</ul>
<ul class="nav navbar-nav navbar-right">
<li class="tableauIcon"><a target="_blank" href="https://tableau.com"><img src="{{ site.baseurl }}/assets/logo.png" alt="Tableau Developers" class="logo" /></a></li>
<li><a target="_blank" href="https://github.com/tableau/server-client-python"><span class="icon icon--github" title="Tableau Server Client on GitHub" alt="Tableau Server Client on GitHub">{% include icon-github.svg %}</span></a></li>
</ul>
</div>
</div>
</nav>
</div>
</header>
1 change: 1 addition & 0 deletions _includes/icon-github.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions _includes/search_form.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<div class="search-container form-group has-feedback">
<form id="docs-search">
<input type="search" id="search-input" class="custom-search form-control" placeholder="Search the docs..." search-url="{{ site.baseurl}}/docs/search.html">
<span class="glyphicon glyphicon-search form-control-feedback"></span>
</form>
</div>

34 changes: 34 additions & 0 deletions _layouts/default.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<!DOCTYPE html>
<html>

<head>
{% include head.html %}
</head>

<body>
<div class="container">
{% include header.html %}
<ul class="blogul">
{% for post in site.posts %}
<div class="row">
<h1>{{ post.title }}</h1>
<hr>
<p><span class="glyphicon glyphicon-time"></span> Posted on {{ post.date | date: "%-d %B %Y" }}</p>
<hr>
<p class="lead">
{{ post.abstract }}
</p>
{% if post.photoname %}
<img class="img-responsive" src="{{ site.baseurl }}/assets/{{ post.photoname}}" alt=""> {% endif %}
<hr>
<div class="blog-content">
{{ post.content }}
</div>
</div>
{% endfor %}
</ul>
{% include footer.html %}
</div>
</body>

</html>
Loading

0 comments on commit 89dc05c

Please sign in to comment.