cs_tools/mkdocs.yml at master · thoughtspot/cs_tools · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
site_name: CS Tools
site_url: https://thoughtspot.github.io/cs_tools/
site_description: >-
  Scale your ThoughtSpot adoption with tools created by the ThoughtSpot Solutions Consulting organization.

repo_name: thoughtspot/cs_tools
repo_url: https://github.com/thoughtspot/cs_tools

copyright: Copyright &copy; 2021 ThoughtSpot Inc. All Rights Reserved

docs_dir: docs

theme:
  name: material
  logo: assets/images/thoughtspot-logo-white.png
  custom_dir: docs/.overrides
  features:
    - announce.dismiss
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - navigation.footer
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.indexes
    - navigation.instant
  favicon: assets/images/favicon.svg
  icon:
    repo: fontawesome/brands/github
  font:
    text: Optimo-Plain
    code: BB Roller Mono
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: thoughtspot-light
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

extra_css:
  - stylesheets/extra.css

hooks:
  # THESE ARE IN ORDER OF PRIORITY.
  - docs/hooks/mirror_bootstrapper.py
  - docs/hooks/cli_reference_generator.py
  - docs/hooks/screenshotter.py

extra:
  # Could investigate in order to offer a beta docs page.
  #
  # version:
  #   provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/thoughtspot/cs_tools
      name: find us on github

markdown_extensions:
  - attr_list
  - admonition
  - def_list
  - footnotes
  - md_in_html
  - pymdownx.betterem
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - docs/.overrides/.icons
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.snippets:
      base_path: docs
      check_paths: true
      url_download: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

plugins:
  - open-in-new-tab
  - redirects:
      redirect_maps:
        # LINKS FROM 1.5.x MAPPED TO 1.6.x
        'tutorial/intro.md': 'getting-started.md'
        'tutorial/install.md': 'getting-started.md#install'
        'tutorial/config.md': 'getting-started.md#configure'
        'tutorial/archiver.md': 'guides/process-archiver.md'
        'tutorial/syncer.md': 'syncer/what-is.md'
        'tools/index.md': 'generated/cli/reference'

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - CLI: generated/cli/reference.md
  - Syncers:
    - "What's a Syncer?": syncer/what-is.md
    - CSV: syncer/csv.md
    - Databricks: syncer/databricks.md
    - Excel: syncer/excel.md
    - Falcon: syncer/falcon.md
    - Google BigQuery: syncer/bigquery.md
    - Google Sheets: syncer/gsheets.md
    - JSON: syncer/json.md
    - Parquet: syncer/parquet.md
    - Mock: syncer/mock.md
    - Postgres: syncer/postgres.md
    - Redshift: syncer/redshift.md
    - Snowflake: syncer/snowflake.md
    - SQLite: syncer/sqlite.md
    - Starburst: syncer/starburst.md
    - Trino: syncer/trino.md
  - Guides:
    - guides/index.md
  - Changelog:
    - v1.6.0: changelog/1.6.0.md
    - v1.5.0: changelog/1.5.0.md
    - v1.4.0: changelog/1.4.0.md
    - v1.3.0: changelog/1.3.0.md
    - v1.2.0: changelog/1.2.0.md
    - v1.1.0: changelog/1.1.0.md
    - v1.0.0: changelog/1.0.0.md