Update the docs

This commit is contained in:
Michael Mintz 2021-01-29 16:20:21 -05:00
parent 7eab686042
commit 0786e35c4f
2 changed files with 18 additions and 22 deletions

View File

@ -111,20 +111,20 @@ pip install seleniumbase
COMMANDS:
install [DRIVER] [OPTIONS]
mkdir [DIRECTORY]
mkfile [FILE.py] [OPTIONS]
mkpres [FILE.py] [LANGUAGE OPTIONS]
options (List common pytest options)
mkdir [DIRECTORY] [OPTIONS]
mkfile [FILE.py] [OPTIONS]
mkpres [FILE.py] [LANG]
print [FILE] [OPTIONS]
translate [SB_FILE.py] [LANG] [ACTION]
convert [WEBDRIVER_UNITTEST_FILE.py]
extract-objects [SB_FILE.py]
inject-objects [SB_FILE.py] [OPTIONS]
objectify [SB_FILE.py] [OPTIONS]
revert-objects [SB_FILE.py]
revert-objects [SB_FILE.py] [OPTIONS]
encrypt (OR: obfuscate)
decrypt (OR: unobfuscate)
download server (Selenium Server JAR file)
download server (The Selenium Grid JAR file)
grid-hub [start|stop] [OPTIONS]
grid-node [start|stop] --hub=[HOST/IP]
* (EXAMPLE: "sbase install chromedriver latest") *

View File

@ -35,6 +35,15 @@ Installs the specified webdriver.
(``iedriver`` is required for Internet Explorer automation)
(``operadriver`` is required for Opera Browser automation)
### options
* Usage:
``sbase options``
* Output:
Displays common pytest command-line options
that are available when using SeleniumBase.
### mkdir
* Usage:
@ -84,10 +93,10 @@ is included.
### mkpres
* Usage:
``sbase mkpres [FILE.py] [LANGUAGE OPTIONS]``
``sbase mkpres [FILE.py] [LANG]``
* Example:
``sbase mkpres new_presentation.py``
``sbase mkpres new_presentation.py --en``
* Language Options:
``--en`` / ``--English`` | ``--zh`` / ``--Chinese``
@ -103,15 +112,6 @@ By default, the slides are written in English.
Slides use "serif" theme & "fade" transition.
This code can be used as a base boilerplate.
### options
* Usage:
``sbase options``
* Output:
Displays common pytest command-line options
that are available when using SeleniumBase.
### print
* Usage:
@ -240,15 +240,11 @@ Runs the password decryption/unobfuscation tool.
### download
* Usage:
``sbase download [ITEM]``
(Options: server)
* Example:
``sbase download server``
* Output:
Downloads the specified item.
(server is required for using your own Selenium Grid)
Downloads the Selenium Server JAR file for Grid usage.
(That JAR file is required when using a Selenium Grid)
### grid-hub