Update the docs

2020-05-15 13:15:37 -04:00 · 2020-05-15 13:15:37 -04:00 · 64273f8a07
parent 9d7112e9ad
commit 64273f8a07
9 changed files with 263 additions and 39 deletions
--- a/README.md
+++ b/README.md
@ -1,5 +1,5 @@
 <meta property="og:title" content="SeleniumBase" />
-<meta property="og:description" content="Create Web UI tests, fast!" />
+<meta property="og:description" content="Create browser tests for web and mobile user interfaces." />
 <meta property="og:image" content="https://cdn2.hubspot.net/hubfs/100006/images/big_blue_logo_7.png" />
 <link rel="icon" href="https://seleniumbase.io/img/favicon.ico">
 <h2 align="center"><a align="center" href="https://github.com/seleniumbase/SeleniumBase/"><img align="center" src="https://cdn2.hubspot.net/hubfs/100006/images/blue_logo_7.png" alt="SeleniumBase" height="170"></a></h2>
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@ -2,3 +2,5 @@ mkdocs==1.1.2
 mkdocs-material==5.0.2
 mkdocs-simple-hooks==0.1.0
 mkdocs-material-extensions==1.0
+mkdocs-minify-plugin==0.3.0
+fontawesome_markdown==0.2.6
--- a/docs/sitemap.xml
+++ b/docs/sitemap.xml
@ -0,0 +1,177 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset
+      xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
+      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9
+            http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd">
+<!-- created with Free Online Sitemap Generator www.xml-sitemaps.com -->
+
+
+<url>
+  <loc>https://seleniumbase.io/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>1.00</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/.</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/help_docs/features_list/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/help_docs/customizing_test_runs/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/examples/ReadMe/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/help_docs/translations/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/examples/example_logs/ReadMe/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/help_docs/method_summary/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/help_docs/mobile_testing/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/seleniumbase/console_scripts/ReadMe/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/examples/tour_examples/ReadMe/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/help_docs/how_it_works/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/help_docs/install_python_pip_git/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/help_docs/virtualenv_instructions/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/help_docs/install/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/help_docs/webdriver_installation/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/help_docs/verify_webdriver/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/seleniumbase/utilities/selenium_ide/ReadMe/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/examples/master_qa/ReadMe/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/examples/visual_testing/ReadMe/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/integrations/github/workflows/ReadMe/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/help_docs/happy_customers/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/help_docs/mysql_installation/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/help_docs/using_safari_driver/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/help_docs/hidden_files_info/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/integrations/azure/jenkins/ReadMe/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/integrations/google_cloud/ReadMe/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/integrations/katalon/ReadMe/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/seleniumbase/common/ReadMe/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/seleniumbase/utilities/selenium_grid/ReadMe/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/integrations/docker/ReadMe/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/seleniumbase/masterqa/ReadMe/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+<url>
+  <loc>https://seleniumbase.io/help_docs/ReadMe/</loc>
+  <lastmod>2020-05-15T07:02:39+00:00</lastmod>
+  <priority>0.80</priority>
+</url>
+
+
+</urlset>
--- a/help_docs/how_it_works.md
+++ b/help_docs/how_it_works.md
@ -1,11 +1,11 @@
 [<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_sb4.png" title="SeleniumBase" height="48">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)

 <a id="how_seleniumbase_works"></a>
-## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> **How it works:**
+## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3.png" title="SeleniumBase" height="32"> **How it works:**

-At the core, SeleniumBase works by extending [pytest](https://docs.pytest.org/en/latest/) and [nosetests](http://nose.readthedocs.io/en/latest/) as a direct plugin to each one. SeleniumBase automatically spins up web browsers for tests, and then gives those tests access to the SeleniumBase libraries through the [BaseCase class](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures/base_case.py). Tests are also given access to SeleniumBase [command-line arguments](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/plugins/pytest_plugin.py), which provide additional functionality.
+At the core, SeleniumBase works by extending [pytest](https://docs.pytest.org/en/latest/) as a direct plugin. SeleniumBase automatically spins up web browsers for tests, and then gives those tests access to the SeleniumBase libraries through the [BaseCase class](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures/base_case.py). Tests are also given access to [SeleniumBase command-line arguments](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/plugins/pytest_plugin.py) and [SeleniumBase methods](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md), which provide additional functionality.

-(NOTE: pytest and nosetests use a feature called test discovery to automatically find and run Python methods that start with "``test_``" from the file that you specified on the command line.)
+(NOTE: pytest uses a feature called test discovery to automatically find and run Python methods that start with "``test_``" from the file that you specified on the command line.)

 To use SeleniumBase calls you need the following:
 ```python
--- a/help_docs/install.md
+++ b/help_docs/install.md
@ -1,20 +1,21 @@
 [<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_sb4.png" title="SeleniumBase" height="48">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)

-## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Installation
+## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3.png" title="SeleniumBase" height="32"> Installation

-If you're installing SeleniumBase from a cloned copy on your machine, use:
-```
+If installing SeleniumBase from a Git clone, use:
+```bash
+git clone https://github.com/seleniumbase/SeleniumBase.git
+cd SeleniumBase/
 pip install -r requirements.txt
-
 python setup.py install
 ```

-If you're installing SeleniumBase directly [from PyPI (the Python Package Index)](https://pypi.python.org/pypi/seleniumbase), use:
+If installing SeleniumBase directly [from PyPI (the Python Package Index)](https://pypi.python.org/pypi/seleniumbase), use:
 ```bash
 pip install seleniumbase
 ```

-If you're installing SeleniumBase [from a GitHub branch](https://github.com/seleniumbase/SeleniumBase), use:
+If installing SeleniumBase [from a GitHub branch](https://github.com/seleniumbase/SeleniumBase), use:
 ```bash
 pip install git+https://github.com/seleniumbase/SeleniumBase.git@master#egg=seleniumbase
 ```
@ -23,4 +24,4 @@ Useful ``pip`` options include:
 * Add ``--upgrade`` OR ``-U`` to upgrade an installation.
 * Add ``--force-reinstall`` for a clean install.

-(If you're not using a virtual environment, you may need to add ``--user`` to your ``pip`` command if you're getting errors during installation.)
+(If you're not using a virtual environment, you may need to add ``--user`` to your ``pip`` command if you're seeing errors during installation.)
--- a/help_docs/using_safari_driver.md
+++ b/help_docs/using_safari_driver.md
@ -2,7 +2,7 @@

 *(NOTE: Safari's WebDriver requires macOS 10.13 "High Sierra" or later.)*

-You can find the official Apple documentation regarding "Testing with WebDriver in Safari" on the following page: https://developer.apple.com/documentation/webkit/testing_with_webdriver_in_safari
+You can find the official Apple documentation regarding "Testing with WebDriver in Safari" on the following page: [https://developer.apple.com/documentation/webkit/testing_with_webdriver_in_safari](https://developer.apple.com/documentation/webkit/testing_with_webdriver_in_safari)

 Run ``safaridriver --enable`` once in a terminal to enable Safari's WebDriver. (If you’re upgrading from a previous macOS release, you may need to prefix the command with ``sudo``.)

--- a/help_docs/virtualenv_instructions.md
+++ b/help_docs/virtualenv_instructions.md
@ -1,6 +1,6 @@
-## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Virtual Environment Tutorial
+## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3.png" title="SeleniumBase" height="32"> Virtual Environment Tutorial

-### **Step 1**: Install VirtualEnv and VirtualEnvWrapper:
+### Step 1: Install VirtualEnv and VirtualEnvWrapper:

 ### macOS / Linux:

@ -23,7 +23,7 @@ If you add ``source `which virtualenvwrapper.sh` `` to your local bash file (``~
 python -m pip install --upgrade virtualenvwrapper-win
 ```

-### **Step 2**: Create a virtual environment:
+### Step 2: Create a virtual environment:

 ### macOS / Linux / Windows:

--- a/mkdocs.yml
+++ b/mkdocs.yml
@ -1,51 +1,95 @@
+# Project information
 site_name: SeleniumBase
+site_url: https://seleniumbase.io/
+site_author: Michael Mintz
+site_description: >-
+  Create browser tests for web and mobile user interfaces.
+  Fully customizable automation that builds on top of Selenium.
+  Uses Python and pytest to run tests and execute commands.
+# 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; 2016 - 2020 Michael Mintz / SeleniumBase
+# Extensions
 markdown_extensions:
-  - codehilite
-  - toc:
+  - fontawesome_markdown
+  - markdown.extensions.admonition
+  - markdown.extensions.attr_list
+  - markdown.extensions.codehilite:
+      guess_lang: false
+  - markdown.extensions.def_list
+  - markdown.extensions.footnotes
+  - markdown.extensions.meta
+  - markdown.extensions.toc:
      permalink: true
+# Configuration
 theme:
  name: material
  logo: https://seleniumbase.io/img/logo3a.png
  favicon: img/favicon.ico
+  language: en
+  features:
+    - tabs
+# Plugins
 plugins:
  - search
+  - minify:
+      minify_html: true
  - mkdocs-simple-hooks:
      hooks:
        on_pre_build: docs.prepare:main
+# Customization
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/seleniumbase/SeleniumBase
+    - icon: fontawesome/brands/gitter
+      link: https://gitter.im/seleniumbase/SeleniumBase
+    - icon: fontawesome/brands/twitter
+      link: https://twitter.com/seleniumbase
+    - icon: fontawesome/brands/facebook
+      link: https://www.facebook.com/SeleniumBase
+    - icon: fontawesome/brands/instagram
+      link: https://instagram.com/seleniumbase
+# Page tree
 nav:
  - Home Page: README.md
  - Features: help_docs/features_list.md
  - CMD Options: help_docs/customizing_test_runs.md
+  - Python Setup:
+    - Install Python, pip, git: help_docs/install_python_pip_git.md
+    - Virtualenv Instructions: help_docs/virtualenv_instructions.md
+  - Installation:
+    - 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
  - Examples: examples/ReadMe.md
  - Translations: help_docs/translations.md
-  - Reports: examples/example_logs/ReadMe.md
  - API Reference: help_docs/method_summary.md
  - Mobile Testing: help_docs/mobile_testing.md
  - Console Scripts: seleniumbase/console_scripts/ReadMe.md
  - Site Tours: examples/tour_examples/ReadMe.md
-  - How it Works: help_docs/how_it_works.md
-  - 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
-  - Recorder and Exporting: seleniumbase/utilities/selenium_ide/ReadMe.md
  - MasterQA: examples/master_qa/ReadMe.md
  - Visual Testing: examples/visual_testing/ReadMe.md
+  - Integrations:
+    - Logging and Reports: examples/example_logs/ReadMe.md
    - GitHub CI: integrations/github/workflows/ReadMe.md
-  - Happy Customers: help_docs/happy_customers.md
-  - MySQL installation: help_docs/mysql_installation.md
-  - Safari Driver Tips: help_docs/using_safari_driver.md
-  - Hidden Files on macOS: help_docs/hidden_files_info.md
+    - Selenium Grid: seleniumbase/utilities/selenium_grid/ReadMe.md
+    - Katalon Integration: integrations/katalon/ReadMe.md
+    - MySQL Help: help_docs/mysql_installation.md
    - Jenkins on Azure: integrations/azure/jenkins/ReadMe.md
    - Jenkins on Google Cloud: integrations/google_cloud/ReadMe.md
-  - Katalon Integration: integrations/katalon/ReadMe.md
-  - Common Decorators: seleniumbase/common/ReadMe.md
-  - Selenium Grid: seleniumbase/utilities/selenium_grid/ReadMe.md
    - Docker Help: integrations/docker/ReadMe.md
+    - Recorder and Exporting: seleniumbase/utilities/selenium_ide/ReadMe.md
    - Master QA: seleniumbase/masterqa/ReadMe.md
-  - Help Docs: help_docs/ReadMe.md
+  - Extra Help:
+    - Table of Contents: help_docs/ReadMe.md
+    - Decorators & Security: seleniumbase/common/ReadMe.md
+    - Using Safari Driver: help_docs/using_safari_driver.md
+    - macOS Hidden Files: help_docs/hidden_files_info.md
+    - Happy Customers: help_docs/happy_customers.md
--- a/seleniumbase/common/ReadMe.md
+++ b/seleniumbase/common/ReadMe.md
@ -1,4 +1,4 @@
-## Using methods from the "common" folder.
+## Using [seleniumbase/common](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/common) methods.

 ### Part 1: Decorators - (from [decorators.py](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/common/decorators.py))