Merge pull request #1772 from seleniumbase/documentation-update

Documentation update

Author: mdmintz

README.md

@@ -13,7 +13,7 @@
 
 <h3 align="center">Create reliable end-to-end browser tests with Python</h3>
 
-<p align="center"><a href="https://pypi.python.org/pypi/seleniumbase" target="_blank"><img src="https://img.shields.io/pypi/v/seleniumbase.svg?color=3399EE" alt="PyPI version" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/releases" target="_blank"><img src="https://img.shields.io/github/v/release/seleniumbase/SeleniumBase.svg?color=22AAEE" alt="GitHub version" /></a> <a href="https://seleniumbase.io"><img src="https://img.shields.io/badge/docs-seleniumbase.io-11BBAA.svg" alt="SeleniumBase Docs" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/actions" target="_blank"><img src="https://github.com/seleniumbase/SeleniumBase/workflows/CI%20build/badge.svg" alt="SeleniumBase GitHub Actions" /></a> <a href="https://gitter.im/seleniumbase/SeleniumBase" target="_blank"><img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt="SeleniumBase" /></a></p>
+<p align="center"><a href="https://pypi.python.org/pypi/seleniumbase" target="_blank"><img src="https://img.shields.io/pypi/v/seleniumbase.svg?color=3399EE" alt="PyPI version" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/releases" target="_blank"><img src="https://img.shields.io/github/v/release/seleniumbase/SeleniumBase.svg?color=22AAEE" alt="GitHub version" /></a> <a href="https://seleniumbase.io"><img src="https://img.shields.io/badge/docs-seleniumbase.io-11BBAA.svg" alt="SeleniumBase Docs" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/actions" target="_blank"><img src="https://github.com/seleniumbase/SeleniumBase/workflows/CI%20build/badge.svg" alt="SeleniumBase GitHub Actions" /></a> <a href="https://gitter.im/seleniumbase/SeleniumBase" target="_blank"><img src="https://img.shields.io/gitter/room/seleniumbase/SeleniumBase.svg" alt="Gitter chat"/></a></p>
 
 <p align="center">
 <a href="#python_installation">🚀 Start</a> |
@@ -1195,7 +1195,8 @@ pytest --reruns=1 --reruns-delay=1
 </p>
 <p><div><a href="https://github.com/mdmintz">https://github.com/mdmintz</a></div></p>
 
-<div><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/fancy_logo_14.png" title="SeleniumBase" width="220" /></a></div> <div><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-22BBCC.svg" title="SeleniumBase" /></a> <a href="https://gitter.im/seleniumbase/SeleniumBase" target="_blank"><img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" title="SeleniumBase" alt="Join the chat!" /></a></div> <div><a href="https://github.com/seleniumbase/SeleniumBase"><img src="https://img.shields.io/badge/tested%20with-SeleniumBase-04C38E.svg" alt="Tested with SeleniumBase" /></a></div> <div><a href="https://seleniumbase.io"><img src="https://img.shields.io/badge/docs-seleniumbase.io-11BBAA.svg" alt="SeleniumBase Docs" /></a></div>
+<div><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/fancy_logo_14.png" title="SeleniumBase" width="220" /></a></div> <div><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-22BBCC.svg" title="SeleniumBase" /></a> <a href="https://gitter.im/seleniumbase/SeleniumBase" target="_blank"><img src="https://img.shields.io/gitter/room/seleniumbase/SeleniumBase.svg" alt="Gitter chat"/></a></div> <div><a href="https://github.com/seleniumbase/SeleniumBase"><img src="https://img.shields.io/badge/tested%20with-SeleniumBase-04C38E.svg" alt="Tested with SeleniumBase" /></a></div> <div><a href="https://seleniumbase.io"><img src="https://img.shields.io/badge/docs-seleniumbase.io-11BBAA.svg" alt="SeleniumBase Docs" /></a></div>
+<p><a href="https://pepy.tech/project/seleniumbase" target="_blank"><img src="https://pepy.tech/badge/seleniumbase" alt="SeleniumBase PyPI downloads" /></a></p>
 
 <p><div>
 <span><a href="https://www.youtube.com/playlist?list=PLp9uKicxkBc5UIlGi2BuE3aWC7JyXpD3m"><img src="https://seleniumbase.github.io/cdn/img/youtube.png" title="SeleniumBase Playlist on YouTube" alt="SeleniumBase Playlist on YouTube" width="54" /></a></span>
@@ -1205,6 +1206,5 @@ pytest --reruns=1 --reruns-delay=1
 
 --------
 
-<p><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/sb_logo_b.png" alt="SeleniumBase" title="SeleniumBase" width="240" /></a></p>
-<p><a href="https://pepy.tech/project/seleniumbase" target="_blank"><img src="https://pepy.tech/badge/seleniumbase" alt="SeleniumBase PyPI downloads" /></a></p>
+<p><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/sb_logo_b.png" alt="SeleniumBase" title="SeleniumBase" width="300" /></a></p>
 <p><a href="https://www.python.org/downloads/" target="_blank"><img src="https://img.shields.io/pypi/pyversions/seleniumbase.svg?color=22AAEE&logo=python&logoColor=FEDC54" title="Supported Python Versions" /></a></p>

mkdocs_build/requirements.txt

@@ -20,14 +20,14 @@ bleach==6.0.0
 lunr==0.6.2
 nltk==3.8.1
 tornado==6.2
-watchdog==2.2.1
+watchdog==2.3.0
 cairocffi==1.4.0
 cairosvg==2.6.0
 cssselect2==0.7.0
 tinycss2==1.2.1
 defusedxml==0.7.1
 mkdocs==1.4.2
-mkdocs-material==9.0.13
+mkdocs-material==9.0.14
 mkdocs-exclude-search==0.6.5
 mkdocs-simple-hooks==0.1.5
 mkdocs-material-extensions==1.1.1

seleniumbase/plugins/pytest_plugin.py

@@ -1196,15 +1196,15 @@ def pytest_addoption(parser):
     for arg in sys_argv:
         if "--timeout=" in arg:
             raise Exception(
-                "\n\n  Don't use --timeout=s from pytest-timeout! "
+                "\n  Don't use --timeout=s from pytest-timeout! "
                 "\n  It's not thread-safe for WebDriver processes! "
                 "\n  Use --time-limit=s from SeleniumBase instead!\n"
             )
 
     # Dashboard Mode does not support tests using forked subprocesses.
     if "--forked" in sys_argv and "--dashboard" in sys_argv:
         raise Exception(
-            "\n\n  Dashboard Mode does NOT support forked subprocesses!"
+            "\n  Dashboard Mode does NOT support forked subprocesses!"
             '\n  (*** DO NOT combine "--forked" with "--dashboard"! ***)\n'
         )
 
@@ -1213,7 +1213,7 @@ def pytest_addoption(parser):
         "--rs" in sys_argv or "--reuse-session" in sys_argv
     ):
         raise Exception(
-            "\n\n  Reuse-Session Mode does NOT support forked subprocesses!"
+            "\n  Reuse-Session Mode does NOT support forked subprocesses!"
             '\n  (DO NOT combine "--forked" with "--rs"/"--reuse-session"!)\n'
         )
 
@@ -1225,7 +1225,7 @@ def pytest_addoption(parser):
     ):
         if ("-n" in sys_argv) or (" -n=" in arg_join) or ("-c" in sys_argv):
             raise Exception(
-                "\n\n  Recorder Mode does NOT support multi-process mode (-n)!"
+                "\n  Recorder Mode does NOT support multi-process mode (-n)!"
                 '\n  (DO NOT combine "--recorder" with "-n NUM_PROCESSES"!)\n'
             )
 
@@ -1303,7 +1303,7 @@ def pytest_addoption(parser):
         sb_config._browser_shortcut = "safari"
         browser_list.append("--safari")
     if browser_changes > 1:
-        message = "\n\n  TOO MANY browser types were entered!"
+        message = "\n  TOO MANY browser types were entered!"
         message += "\n  There were %s found:\n  >  %s" % (
             browser_changes,
             ", ".join(browser_list),
@@ -1317,7 +1317,7 @@ def pytest_addoption(parser):
         and browser_text not in ["chrome", "edge"]
     ):
         message = (
-            "\n\n  Recorder Mode ONLY supports Chrome and Edge!"
+            "\n  Recorder Mode ONLY supports Chrome and Edge!"
             '\n  (Your browser choice was: "%s")\n' % browser_list[0]
         )
         raise Exception(message)
@@ -1340,21 +1340,20 @@ def pytest_addoption(parser):
         and undetectable
     ):
         message = (
-            '\n\n  Undetected-Chromedriver Mode ONLY supports Chrome!'
+            '\n  Undetected-Chromedriver Mode ONLY supports Chrome!'
             '\n  ("--uc" / "--undetected" / "--undetectable")'
             '\n  (Your browser choice was: "%s")\n' % browser_list[0]
         )
         raise Exception(message)
     if undetectable and "--wire" in sys_argv:
         raise Exception(
-            "\n\n  SeleniumBase doesn't support mixing --uc with --wire mode!"
+            "\n  SeleniumBase doesn't support mixing --uc with --wire mode!"
             "\n  If you need both, override get_new_driver() from BaseCase:"
             "\n  https://seleniumbase.io/help_docs/syntax_formats/#sb_sf_09\n"
         )
     if undetectable and "--mobile" in sys_argv:
         raise Exception(
-            "\n\n  SeleniumBase doesn't support mixing --uc with --mobile"
-            '\n  UC has: "unrecognized chrome option: mobileEmulation"!\n'
+            "\n  SeleniumBase doesn't support mixing --uc with --mobile\n"
         )