Skip to content

Commit c9c5984

Browse files
mdmintzmdmintz
committed
Update the docs
1 parent 70be9b0 commit c9c5984

File tree

3 files changed

+99
-63
lines changed

3 files changed

+99
-63
lines changed

‎help_docs/uc_mode.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,22 @@
88
99
---
1010

11-
<!-- YouTube View --><a href="https://www.youtube.com/watch?v=5dMFI3e85ig"><img src="http://img.youtube.com/vi/5dMFI3e85ig/0.jpg" title="SeleniumBase on YouTube" width="350" /></a>
11+
<!-- YouTube View --><a href="https://www.youtube.com/watch?v=5dMFI3e85ig"><img src="http://img.youtube.com/vi/5dMFI3e85ig/0.jpg" title="SeleniumBase on YouTube" width="320" /></a>
1212
<p>(<b><a href="https://www.youtube.com/watch?v=5dMFI3e85ig">Watch the 1st UC Mode tutorial on YouTube! ▶️</a></b>)</p>
1313

1414
----
1515

16-
<!-- YouTube View --><a href="https://www.youtube.com/watch?v=2pTpBtaE7SQ"><img src="http://img.youtube.com/vi/2pTpBtaE7SQ/0.jpg" title="SeleniumBase on YouTube" width="350" /></a>
16+
<!-- YouTube View --><a href="https://www.youtube.com/watch?v=2pTpBtaE7SQ"><img src="http://img.youtube.com/vi/2pTpBtaE7SQ/0.jpg" title="SeleniumBase on YouTube" width="320" /></a>
1717
<p>(<b><a href="https://www.youtube.com/watch?v=2pTpBtaE7SQ">Watch the 2nd UC Mode tutorial on YouTube! ▶️</a></b>)</p>
1818

1919
----
2020

21-
<!-- YouTube View --><a href="https://www.youtube.com/watch?v=-EpZlhGWo9k"><img src="http://img.youtube.com/vi/-EpZlhGWo9k/0.jpg" title="SeleniumBase on YouTube" width="350" /></a>
21+
<!-- YouTube View --><a href="https://www.youtube.com/watch?v=-EpZlhGWo9k"><img src="http://img.youtube.com/vi/-EpZlhGWo9k/0.jpg" title="SeleniumBase on YouTube" width="320" /></a>
2222
<p>(<b><a href="https://www.youtube.com/watch?v=-EpZlhGWo9k">Watch the 3rd UC Mode tutorial on YouTube! ▶️</a></b>)</p>
2323

2424
----
2525

26-
<!-- YouTube View --><a href="https://www.youtube.com/watch?v=Mr90iQmNsKM"><img src="http://img.youtube.com/vi/Mr90iQmNsKM/0.jpg" title="SeleniumBase on YouTube" width="350" /></a>
26+
<!-- YouTube View --><a href="https://www.youtube.com/watch?v=Mr90iQmNsKM"><img src="http://img.youtube.com/vi/Mr90iQmNsKM/0.jpg" title="SeleniumBase on YouTube" width="320" /></a>
2727
<p>(<b><a href="https://www.youtube.com/watch?v=Mr90iQmNsKM">Watch the 4th UC Mode tutorial on YouTube! ▶️</a></b>)</p>
2828

2929
----

‎integrations/docker/ReadMe.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ https://docs.docker.com/engine/install/
1414

1515
docker build -t seleniumbase .
1616

17-
If running on an Apple M1/M2 Mac, use this instead:
17+
**(NOTE) - If running on an Apple M1/M2 Mac, use this instead:**
1818

1919
docker build --platform linux/amd64 -t seleniumbase .
2020

21-
M1/M2 Mac users should also see [StackOverflow.com/a/76586216/7058266](https://stackoverflow.com/a/76586216/7058266) to **Enable Rosetta in Docker Desktop**. (Otherwise **you will** encounter errors like this when Chrome tries to launch: `"Chrome failed to start: crashed."`)
21+
**M1/M2 Mac users** should also see [StackOverflow.com/a/76586216/7058266](https://stackoverflow.com/a/76586216/7058266) to **Enable Rosetta in Docker Desktop**. (Otherwise **you will** encounter errors like this when Chrome tries to launch: `"Chrome failed to start: crashed."`)
2222

2323
#### 4. Run [the example test](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py) with Chrome inside your Docker: (Once the test completes after a few seconds, you'll automatically exit the Docker shell)
2424

‎seleniumbase/console_scripts/ReadMe.md

+93-57
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,9 @@ sbase mkdir ui_tests
290290
291291
* Options:
292292
293-
``-b`` / ``--basic`` (Only config files. No tests added.)
293+
```bash
294+
-b / --basic (Only config files. No tests added.)
295+
```
294296
295297
* Output:
296298
@@ -350,27 +352,33 @@ sbase mkfile new_test.py
350352
351353
* Options:
352354
353-
``--uc`` (UC Mode boilerplate using SB context manager)
354-
`-b` / `--basic` (Basic boilerplate / single-line test)
355-
`-r` / `--rec` (Adds Pdb+ breakpoint for Recorder Mode)
356-
``--url=URL`` (Makes the test start on a specific page)
355+
```bash
356+
--uc (UC Mode boilerplate using SB context manager)
357+
-b / --basic (Basic boilerplate / single-line test)
358+
-r / --rec (Adds Pdb+ breakpoint for Recorder Mode)
359+
--url=URL (Makes the test start on a specific page)
360+
```
357361
358362
* Language Options:
359363
360-
``--en`` / ``--English`` | ``--zh`` / ``--Chinese``
361-
``--nl`` / ``--Dutch`` | ``--fr`` / ``--French``
362-
``--it`` / ``--Italian`` | ``--ja`` / ``--Japanese``
363-
``--ko`` / ``--Korean`` | ``--pt`` / ``--Portuguese``
364-
``--ru`` / ``--Russian`` | ``--es`` / ``--Spanish``
364+
```bash
365+
--en / --English | --zh / --Chinese
366+
--nl / --Dutch | --fr / --French
367+
--it / --Italian | --ja / --Japanese
368+
--ko / --Korean | --pt / --Portuguese
369+
--ru / --Russian | --es / --Spanish
370+
```
365371
366372
* Syntax Formats:
367373
368-
``--bc`` / ``--basecase`` (BaseCase class inheritance)
369-
``--pf`` / ``--pytest-fixture`` (sb pytest fixture)
370-
``--cf`` / ``--class-fixture`` (class + sb pytest fixture)
371-
``--cm`` / ``--context-manager`` (SB context manager)
372-
``--dc`` / ``--driver-context`` (DriverContext manager)
373-
``--dm`` / ``--driver-manager`` (Driver manager)
374+
```bash
375+
--bc / --basecase (BaseCase class inheritance)
376+
--pf / --pytest-fixture (sb pytest fixture)
377+
--cf / --class-fixture (class + sb pytest fixture)
378+
--cm / --context-manager (SB context manager)
379+
--dc / --driver-context (DriverContext manager)
380+
--dm / --driver-manager (Driver manager)
381+
```
374382
375383
* Output:
376384
@@ -404,13 +412,15 @@ sbase codegen new_test.py --url=wikipedia.org
404412
405413
* Options:
406414
407-
``--url=URL`` (Sets the initial start page URL.)
408-
``--edge`` (Use Edge browser instead of Chrome.)
409-
``--gui`` / ``--headed`` (Use headed mode on Linux.)
410-
``--uc`` / ``--undetected`` (Use undetectable mode.)
411-
``--ee`` (Use SHIFT + ESC to end the recording.)
412-
``--overwrite`` (Overwrite file when it exists.)
413-
``--behave`` (Also output Behave/Gherkin files.)
415+
```bash
416+
--url=URL (Sets the initial start page URL.)
417+
--edge (Use Edge browser instead of Chrome.)
418+
--gui / --headed (Use headed mode on Linux.)
419+
--uc / --undetected (Use undetectable mode.)
420+
--ee (Use SHIFT + ESC to end the recording.)
421+
--overwrite (Overwrite file when it exists.)
422+
--behave (Also output Behave/Gherkin files.)
423+
```
414424
415425
* Output:
416426
@@ -427,8 +437,10 @@ sbase recorder [OPTIONS]
427437
428438
* Options:
429439
430-
``--uc`` / ``--undetected`` (Use undetectable mode.)
431-
``--behave`` (Also output Behave/Gherkin files.)
440+
```bash
441+
--uc / --undetected (Use undetectable mode.)
442+
--behave (Also output Behave/Gherkin files.)
443+
```
432444
433445
* Output:
434446
@@ -450,11 +462,13 @@ sbase mkpres new_presentation.py --en
450462
451463
* Language Options:
452464
453-
``--en`` / ``--English`` | ``--zh`` / ``--Chinese``
454-
``--nl`` / ``--Dutch`` | ``--fr`` / ``--French``
455-
``--it`` / ``--Italian`` | ``--ja`` / ``--Japanese``
456-
``--ko`` / ``--Korean`` | ``--pt`` / ``--Portuguese``
457-
``--ru`` / ``--Russian`` | ``--es`` / ``--Spanish``
465+
```bash
466+
--en / --English | --zh / --Chinese
467+
--nl / --Dutch | --fr / --French
468+
--it / --Italian | --ja / --Japanese
469+
--ko / --Korean | --pt / --Portuguese
470+
--ru / --Russian | --es / --Spanish
471+
```
458472
459473
* Output:
460474
@@ -480,11 +494,13 @@ sbase mkchart new_chart.py --en
480494
481495
* Language Options:
482496
483-
``--en`` / ``--English`` | ``--zh`` / ``--Chinese``
484-
``--nl`` / ``--Dutch`` | ``--fr`` / ``--French``
485-
``--it`` / ``--Italian`` | ``--ja`` / ``--Japanese``
486-
``--ko`` / ``--Korean`` | ``--pt`` / ``--Portuguese``
487-
``--ru`` / ``--Russian`` | ``--es`` / ``--Spanish``
497+
```bash
498+
--en / --English | --zh / --Chinese
499+
--nl / --Dutch | --fr / --French
500+
--it / --Italian | --ja / --Japanese
501+
--ko / --Korean | --pt / --Portuguese
502+
--ru / --Russian | --es / --Spanish
503+
```
488504
489505
* Output:
490506
@@ -504,7 +520,9 @@ sbase print [FILE] [OPTIONS]
504520
505521
* Options:
506522
507-
``-n`` (Add line Numbers to the rows)
523+
```bash
524+
-n (Add line Numbers to the rows)
525+
```
508526
509527
* Output:
510528
@@ -521,21 +539,27 @@ sbase translate [SB_FILE.py] [LANGUAGE] [ACTION]
521539
522540
* Languages:
523541
524-
``--en`` / ``--English`` | ``--zh`` / ``--Chinese``
525-
``--nl`` / ``--Dutch`` | ``--fr`` / ``--French``
526-
``--it`` / ``--Italian`` | ``--ja`` / ``--Japanese``
527-
``--ko`` / ``--Korean`` | ``--pt`` / ``--Portuguese``
528-
``--ru`` / ``--Russian`` | ``--es`` / ``--Spanish``
542+
```bash
543+
--en / --English | --zh / --Chinese
544+
--nl / --Dutch | --fr / --French
545+
--it / --Italian | --ja / --Japanese
546+
--ko / --Korean | --pt / --Portuguese
547+
--ru / --Russian | --es / --Spanish
548+
```
529549
530550
* Actions:
531551
532-
``-p`` / ``--print`` (Print translation output to the screen)
533-
``-o`` / ``--overwrite`` (Overwrite the file being translated)
534-
``-c`` / ``--copy`` (Copy the translation to a new ``.py`` file)
552+
```bash
553+
-p / --print (Print translation output to the screen)
554+
-o / --overwrite (Overwrite the file being translated)
555+
-c / --copy (Copy the translation to a new ``.py`` file)
556+
```
535557
536558
* Options:
537559
538-
``-n`` (include line Numbers when using the Print action)
560+
```bash
561+
-n (include line Numbers when using the Print action)
562+
```
539563
540564
* Output:
541565
@@ -573,7 +597,9 @@ sbase inject-objects [SB_FILE.py] [OPTIONS]
573597
574598
* Options:
575599
576-
``-c``, ``--comments`` (Add object selectors to the comments.)
600+
```bash
601+
-c / --comments (Add object selectors to the comments.)
602+
```
577603
578604
* Output:
579605
@@ -591,7 +617,9 @@ sbase objectify [SB_FILE.py] [OPTIONS]
591617
592618
* Options:
593619
594-
``-c``, ``--comments`` (Add object selectors to the comments.)
620+
```bash
621+
-c / --comments (Add object selectors to the comments.)
622+
```
595623
596624
* Output:
597625
@@ -611,7 +639,9 @@ sbase revert-objects [SB_FILE.py] [OPTIONS]
611639
612640
* Options:
613641
614-
``-c``, ``--comments`` (Keep existing comments for the lines.)
642+
```bash
643+
-c / --comments (Keep existing comments for the lines.)
644+
```
615645
616646
* Output:
617647
@@ -639,7 +669,7 @@ Works on both Selenium IDE & Katalon Recorder scripts.
639669
640670
* Usage:
641671
642-
``sbase encrypt`` OR ``sbase obfuscate``
672+
``sbase encrypt`` / ``sbase obfuscate``
643673
644674
* Output:
645675
@@ -650,7 +680,7 @@ Runs the password encryption/obfuscation tool.
650680
651681
* Usage:
652682
653-
``sbase decrypt`` OR ``sbase unobfuscate``
683+
``sbase decrypt`` / ``sbase unobfuscate``
654684
655685
* Output:
656686
@@ -667,9 +697,11 @@ sbase proxy [OPTIONS]
667697
668698
* Options:
669699
670-
``--hostname=HOSTNAME`` (Set ``hostname``) (Default: ``127.0.0.1``)
671-
``--port=PORT`` (Set ``port``) (Default: ``8899``)
672-
``--help`` / ``-h`` (Display list of all available ``proxy`` options.)
700+
```bash
701+
--hostname=HOSTNAME (Set `hostname`) (Default: `127.0.0.1`)
702+
--port=PORT (Set `port`) (Default: `8899`)
703+
--help / -h (Display available `proxy` options.)
704+
```
673705
674706
* Output:
675707
@@ -699,8 +731,10 @@ sbase grid-hub {start|stop|restart} [OPTIONS]
699731
700732
* Options:
701733
702-
``-v``, ``--verbose`` (Increases verbosity of logging output.)
703-
``--timeout=TIMEOUT`` (Close idle browser windows after TIMEOUT seconds.)
734+
```bash
735+
-v / --verbose (Increases verbosity of logging output.)
736+
--timeout=TIMEOUT (Close idle browser windows after TIMEOUT seconds.)
737+
```
704738
705739
* Output:
706740
@@ -720,8 +754,10 @@ sbase grid-node {start|stop|restart} [OPTIONS]
720754
721755
* Options:
722756
723-
``--hub=HUB_IP`` (The Grid Hub IP Address to connect to.) (Default: ``127.0.0.1``)
724-
``-v``, ``--verbose`` (Increases verbosity of logging output.)
757+
```bash
758+
--hub=HUB_IP (Grid Hub IP Address. Default: `127.0.0.1`)
759+
-v / --verbose (Increases verbosity of logging output.)
760+
```
725761
726762
* Output:
727763

0 commit comments

Comments
 (0)