SeleniumBase/mkdocs.yml

# Project information
site_name: SeleniumBase / Docs
site_url: https://seleniumbase.io
site_author: Michael Mintz
site_description: A fast, reliable web automation framework for end-to-end testing (and RPA) with Python, pytest, and WebDriver.
# Repository information
repo_name: seleniumbase/SeleniumBase
repo_url: https://github.com/seleniumbase/SeleniumBase
edit_uri: ""
site_dir: "site"
docs_dir: "docs"
# Copyright
copyright: Copyright &copy; 2014 - 2021 Michael Mintz / SeleniumBase
# Extensions
markdown_extensions:
  - markdown.extensions.admonition
  - markdown.extensions.attr_list
  - markdown.extensions.codehilite
  - markdown.extensions.meta
  - markdown.extensions.def_list
  - markdown.extensions.footnotes
  - markdown.extensions.toc:
      permalink: true
# Configuration
theme:
  name: material
  logo: img/grad_logo.png
  favicon: img/grad_logo.png
  include_homepage_in_sidebar: true
  sticky_navigation: true
  language: en
  include_search_page: false
  search_index_only: false
  features:
    - tabs
    - instant
  palette:
    scheme: default
    primary: blue
    accent: indigo
  font:
    text: Roboto
    code: Roboto Mono
  icon:
    logo: img/sb_logo_7.png
# Plugins
plugins:
  - search
  - minify:
      minify_html: true
  - mkdocs-simple-hooks:
      hooks:
        on_pre_build: docs.prepare:main
# Page tree
nav:
  - SeleniumBase / README: README.md
  - Features List: help_docs/features_list.md
  - Running Example Tests: examples/ReadMe.md
  - Command Line Options: help_docs/customizing_test_runs.md
  - Dashboard / Reports: examples/example_logs/ReadMe.md
  - Console Scripts: seleniumbase/console_scripts/ReadMe.md
  - Syntax Formats: help_docs/syntax_formats.md
  - API Reference: help_docs/method_summary.md
  - Setup / Install:
    - Install Python, pip, git: help_docs/install_python_pip_git.md
    - Virtualenv Instructions: help_docs/virtualenv_instructions.md
    - Install SeleniumBase: help_docs/install.md
    - WebDriver Installation: help_docs/webdriver_installation.md
    - Verifying WebDriver: help_docs/verify_webdriver.md
    - How it Works: help_docs/how_it_works.md
  - Languages:
    - Translations: help_docs/translations.md
    - Chinese / 中文文件: help_docs/chinese.md
    - Locale Codes: help_docs/locale_codes.md
  - JS Generators:
    - Tour Maker: examples/tour_examples/ReadMe.md
    - Presentation Maker: examples/presenter/ReadMe.md
    - Chart Maker: help_docs/chart_maker.md
  - Integrations:
    - Mobile Testing: help_docs/mobile_testing.md
    - GitHub CI: integrations/github/workflows/ReadMe.md
    - Selenium Grid: seleniumbase/utilities/selenium_grid/ReadMe.md
    - Katalon Recorder: integrations/katalon/ReadMe.md
    - MasterQA: examples/master_qa/ReadMe.md
    - Visual Testing: examples/visual_testing/ReadMe.md
    - Jenkins on Azure: integrations/azure/jenkins/ReadMe.md
    - Jenkins on Google Cloud: integrations/google_cloud/ReadMe.md
    - Recorder Export/Convert: seleniumbase/utilities/selenium_ide/ReadMe.md
    - NodeJS Test Runner: https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/node_js
    - HighCharts: examples/chart_maker/ReadMe.md
  - Help Docs:
    - Table of Contents: help_docs/ReadMe.md
    - Master QA: seleniumbase/masterqa/ReadMe.md
    - JS Package Manager: help_docs/js_package_manager.md
    - Decorators & Security: seleniumbase/common/ReadMe.md
    - Desired Capabilities: help_docs/desired_capabilities.md
    - Using Safari Driver: help_docs/using_safari_driver.md
    - macOS Hidden Files: help_docs/hidden_files_info.md
    - Docker Help: integrations/docker/ReadMe.md
    - MySQL Help: help_docs/mysql_installation.md
    - Case Studies: help_docs/happy_customers.md
  - Demo Pages:
    - Demo Page / Demo Site: https://seleniumbase.io/demo_page
    - TinyMCE Demo Page: https://seleniumbase.io/other/tinymce
    - Virtual Device Farm: https://seleniumbase.io/devices/
    - Error Demo Page: https://seleniumbase.io/error_page/
  - Presentations:
    - Presenter Demo: https://seleniumbase.io/other/presenter.html
    - Core Presentation: https://seleniumbase.io/other/core_presentation.html
    - Chart Maker Demo: https://seleniumbase.io/other/chart_presentation.html
    - Virtual Env Tutorial: https://seleniumbase.io/other/py_virtual_envs.html
  - Thank You: help_docs/thank_you.md
# Google Analytics
google_analytics: ['UA-167313767-1', 'seleniumbase.io']
Update the docs 2020-05-16 01:15:37 +08:00			`# Project information`
Update the docs 2021-01-12 14:20:37 +08:00			`site_name: SeleniumBase / Docs`
Update the docs 2020-05-16 04:31:04 +08:00			`site_url: https://seleniumbase.io`
Update the docs 2020-05-16 01:15:37 +08:00			`site_author: Michael Mintz`
Update the docs 2020-12-27 10:03:17 +08:00			`site_description: A fast, reliable web automation framework for end-to-end testing (and RPA) with Python, pytest, and WebDriver.`
Update the docs 2020-05-16 01:15:37 +08:00			`# Repository information`
			`repo_name: seleniumbase/SeleniumBase`
Update the docs 2020-05-16 04:31:04 +08:00			`repo_url: https://github.com/seleniumbase/SeleniumBase`
Add initial setup for mkdocs 2020-05-12 01:33:54 +08:00			`edit_uri: ""`
			`site_dir: "site"`
			`docs_dir: "docs"`
Update the docs 2020-05-16 01:15:37 +08:00			`# Copyright`
Update the docs 2020-10-07 01:03:45 +08:00			`copyright: Copyright © 2014 - 2021 Michael Mintz / SeleniumBase`
Update the docs 2020-05-16 01:15:37 +08:00			`# Extensions`
Add initial setup for mkdocs 2020-05-12 01:33:54 +08:00			`markdown_extensions:`
Update the docs 2020-05-16 01:15:37 +08:00			`- markdown.extensions.admonition`
			`- markdown.extensions.attr_list`
Update mkdocs 2020-05-16 04:02:00 +08:00			`- markdown.extensions.codehilite`
Update the docs 2020-05-22 11:07:22 +08:00			`- markdown.extensions.meta`
Update the docs 2020-05-16 01:15:37 +08:00			`- markdown.extensions.def_list`
			`- markdown.extensions.footnotes`
			`- markdown.extensions.toc:`
Add initial setup for mkdocs 2020-05-12 01:33:54 +08:00			`permalink: true`
Update the docs 2020-05-16 01:15:37 +08:00			`# Configuration`
Add initial setup for mkdocs 2020-05-12 01:33:54 +08:00			`theme:`
			`name: material`
Update the docs 2020-12-18 14:27:39 +08:00			`logo: img/grad_logo.png`
Update the docs 2020-12-21 05:47:57 +08:00			`favicon: img/grad_logo.png`
Update the docs 2020-05-16 12:13:17 +08:00			`include_homepage_in_sidebar: true`
			`sticky_navigation: true`
Update the docs 2020-05-20 02:40:44 +08:00			`language: en`
			`include_search_page: false`
Update the docs 2021-01-12 14:20:37 +08:00			`search_index_only: false`
Update the docs 2020-05-16 01:15:37 +08:00			`features:`
			`- tabs`
Update the docs 2020-10-22 21:37:35 +08:00			`- instant`
Update the docs 2020-05-18 06:25:35 +08:00			`palette:`
Update the docs 2020-05-20 02:40:44 +08:00			`scheme: default`
Update mkdocs 2020-05-18 14:01:48 +08:00			`primary: blue`
Update the docs 2020-05-18 06:25:35 +08:00			`accent: indigo`
Update the docs 2020-05-20 02:40:44 +08:00			`font:`
			`text: Roboto`
			`code: Roboto Mono`
			`icon:`
Update the docs 2020-05-22 11:07:22 +08:00			`logo: img/sb_logo_7.png`
Update the docs 2020-05-16 01:15:37 +08:00			`# Plugins`
Add initial setup for mkdocs 2020-05-12 01:33:54 +08:00			`plugins:`
			`- search`
Update the docs 2020-05-16 01:15:37 +08:00			`- minify:`
Update the docs 2020-10-22 21:37:35 +08:00			`minify_html: true`
Add initial setup for mkdocs 2020-05-12 01:33:54 +08:00			`- mkdocs-simple-hooks:`
			`hooks:`
			`on_pre_build: docs.prepare:main`
Update the docs 2020-05-16 01:15:37 +08:00			`# Page tree`
Add initial setup for mkdocs 2020-05-12 01:33:54 +08:00			`nav:`
Update the docs 2021-01-12 14:20:37 +08:00			`- SeleniumBase / README: README.md`
Update mkdocs 2020-09-22 02:49:13 +08:00			`- Features List: help_docs/features_list.md`
			`- Running Example Tests: examples/ReadMe.md`
			`- Command Line Options: help_docs/customizing_test_runs.md`
Update the docs 2020-12-25 01:39:07 +08:00			`- Dashboard / Reports: examples/example_logs/ReadMe.md`
Update mkdocs 2020-09-22 02:49:13 +08:00			`- Console Scripts: seleniumbase/console_scripts/ReadMe.md`
Update the docs 2020-12-27 10:03:17 +08:00			`- Syntax Formats: help_docs/syntax_formats.md`
Update mkdocs 2020-09-22 02:49:13 +08:00			`- API Reference: help_docs/method_summary.md`
			`- Setup / Install:`
Update the docs 2020-05-16 01:15:37 +08:00			`- Install Python, pip, git: help_docs/install_python_pip_git.md`
			`- Virtualenv Instructions: help_docs/virtualenv_instructions.md`
			`- Install SeleniumBase: help_docs/install.md`
			`- WebDriver Installation: help_docs/webdriver_installation.md`
			`- Verifying WebDriver: help_docs/verify_webdriver.md`
Update the docs 2020-05-23 13:11:53 +08:00			`- How it Works: help_docs/how_it_works.md`
Update mkdocs 2020-09-22 02:49:13 +08:00			`- Languages:`
Update the docs 2020-06-08 01:41:56 +08:00			`- Translations: help_docs/translations.md`
			`- Chinese / 中文文件: help_docs/chinese.md`
Update mkdocs 2020-09-13 23:58:32 +08:00			`- Locale Codes: help_docs/locale_codes.md`
Update mkdocs 2020-09-22 02:49:13 +08:00			`- JS Generators:`
Update mkdocs for seleniumbase.io 2020-09-18 02:16:50 +08:00			`- Tour Maker: examples/tour_examples/ReadMe.md`
			`- Presentation Maker: examples/presenter/ReadMe.md`
			`- Chart Maker: help_docs/chart_maker.md`
Update the docs 2020-05-16 01:15:37 +08:00			`- Integrations:`
Update mkdocs 2020-09-22 02:49:13 +08:00			`- Mobile Testing: help_docs/mobile_testing.md`
Update the docs 2020-05-16 01:15:37 +08:00			`- GitHub CI: integrations/github/workflows/ReadMe.md`
			`- Selenium Grid: seleniumbase/utilities/selenium_grid/ReadMe.md`
Update the docs 2020-05-23 13:11:53 +08:00			`- Katalon Recorder: integrations/katalon/ReadMe.md`
			`- MasterQA: examples/master_qa/ReadMe.md`
Update mkdocs for seleniumbase.io 2020-09-18 02:16:50 +08:00			`- Visual Testing: examples/visual_testing/ReadMe.md`
Update the docs 2020-05-16 01:15:37 +08:00			`- Jenkins on Azure: integrations/azure/jenkins/ReadMe.md`
			`- Jenkins on Google Cloud: integrations/google_cloud/ReadMe.md`
Update mkdocs 2020-09-22 02:49:13 +08:00			`- Recorder Export/Convert: seleniumbase/utilities/selenium_ide/ReadMe.md`
Update the docs 2020-08-08 13:21:46 +08:00			`- NodeJS Test Runner: https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/node_js`
Update mkdocs 2020-09-13 23:58:32 +08:00			`- HighCharts: examples/chart_maker/ReadMe.md`
Update mkdocs 2020-09-22 02:49:13 +08:00			`- Help Docs:`
Update the docs 2020-05-16 01:15:37 +08:00			`- Table of Contents: help_docs/ReadMe.md`
Update the docs 2020-05-17 03:56:34 +08:00			`- Master QA: seleniumbase/masterqa/ReadMe.md`
Update mkdocs for seleniumbase.io 2020-09-18 02:16:50 +08:00			`- JS Package Manager: help_docs/js_package_manager.md`
Update the docs 2020-05-16 01:15:37 +08:00			`- Decorators & Security: seleniumbase/common/ReadMe.md`
Update the docs 2020-05-18 09:50:11 +08:00			`- Desired Capabilities: help_docs/desired_capabilities.md`
Update the docs 2020-05-16 01:15:37 +08:00			`- Using Safari Driver: help_docs/using_safari_driver.md`
			`- macOS Hidden Files: help_docs/hidden_files_info.md`
Update mkdocs for seleniumbase.io 2020-09-18 02:16:50 +08:00			`- Docker Help: integrations/docker/ReadMe.md`
			`- MySQL Help: help_docs/mysql_installation.md`
Update the docs 2020-05-18 06:25:35 +08:00			`- Case Studies: help_docs/happy_customers.md`
Update mkdocs 2020-09-22 02:49:13 +08:00			`- Demo Pages:`
Update mkdocs for seleniumbase.io 2020-09-18 02:16:50 +08:00			`- Demo Page / Demo Site: https://seleniumbase.io/demo_page`
			`- TinyMCE Demo Page: https://seleniumbase.io/other/tinymce`
Update the docs 2020-10-22 21:37:35 +08:00			`- Virtual Device Farm: https://seleniumbase.io/devices/`
Update mkdocs for seleniumbase.io 2020-09-18 02:16:50 +08:00			`- Error Demo Page: https://seleniumbase.io/error_page/`
Update the docs 2021-01-12 14:20:37 +08:00			`- Presentations:`
Update mkdocs for seleniumbase.io 2020-09-18 02:16:50 +08:00			`- Presenter Demo: https://seleniumbase.io/other/presenter.html`
			`- Core Presentation: https://seleniumbase.io/other/core_presentation.html`
			`- Chart Maker Demo: https://seleniumbase.io/other/chart_presentation.html`
Update the docs 2021-01-06 23:19:31 +08:00			`- Virtual Env Tutorial: https://seleniumbase.io/other/py_virtual_envs.html`
Update the docs 2020-10-22 21:37:35 +08:00			`- Thank You: help_docs/thank_you.md`
Update the docs 2020-05-22 11:07:22 +08:00			`# Google Analytics`
			`google_analytics: ['UA-167313767-1', 'seleniumbase.io']`