Skip to content

Commit e6865c7

Browse files
committed
Update the docs
1 parent 16fe4b2 commit e6865c7

File tree

3 files changed

+8
-4
lines changed

3 files changed

+8
-4
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -657,6 +657,7 @@ pytest test_coffee_cart.py --trace
657657
--headless2 # (Use the new headless mode, which supports extensions.)
658658
--headed # (Run tests in headed/GUI mode on Linux OS, where not default.)
659659
--xvfb # (Run tests using the Xvfb virtual display server on Linux OS.)
660+
--xvfb-metrics=STRING # (Set Xvfb display size on Linux: "Width,Height".)
660661
--locale=LOCALE_CODE # (Set the Language Locale Code for the web browser.)
661662
--interval=SECONDS # (The autoplay interval for presentations & tour steps)
662663
--start-page=URL # (The starting URL for the web browser when tests begin.)
@@ -701,6 +702,7 @@ pytest test_coffee_cart.py --trace
701702
--rcs | --reuse-class-session # (Reuse session for tests in class.)
702703
--crumbs # (Delete all cookies between tests reusing a session.)
703704
--disable-beforeunload # (Disable the "beforeunload" event on Chrome.)
705+
--window-position=X,Y # (Set the browser's starting window position.)
704706
--window-size=WIDTH,HEIGHT # (Set the browser's starting window size.)
705707
--maximize # (Start tests with the browser window maximized.)
706708
--screenshot # (Save a screenshot at the end of each test.)
@@ -869,7 +871,7 @@ pytest test_suite.py --dashboard --html=report.html
869871
870872
<img src="https://seleniumbase.github.io/cdn/img/dash_report.jpg" alt="Dashboard Pytest HTML Report" title="Dashboard Pytest HTML Report" width="520" />
871873
872-
If viewing pytest html reports in [Jenkins](https://www.jenkins.io/), you may need to [configure Jenkins settings](https://stackoverflow.com/a/46197356) for the html to render correctly. This is due to [Jenkins CSP changes](https://www.jenkins.io/doc/book/system-administration/security/configuring-content-security-policy/).
874+
If viewing pytest html reports in [Jenkins](https://www.jenkins.io/), you may need to [configure Jenkins settings](https://stackoverflow.com/a/46197356/7058266) for the html to render correctly. This is due to [Jenkins CSP changes](https://www.jenkins.io/doc/book/system-administration/security/configuring-content-security-policy/).
873875
874876
You can also use ``--junit-xml=report.xml`` to get an xml report instead. Jenkins can use this file to display better reporting for your tests.
875877

help_docs/customizing_test_runs.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,7 @@ pytest my_first_test.py --settings-file=custom_settings.py
148148
--headless2 # (Use the new headless mode, which supports extensions.)
149149
--headed # (Run tests in headed/GUI mode on Linux OS, where not default.)
150150
--xvfb # (Run tests using the Xvfb virtual display server on Linux OS.)
151+
--xvfb-metrics=STRING # (Set Xvfb display size on Linux: "Width,Height".)
151152
--locale=LOCALE_CODE # (Set the Language Locale Code for the web browser.)
152153
--interval=SECONDS # (The autoplay interval for presentations & tour steps)
153154
--start-page=URL # (The starting URL for the web browser when tests begin.)
@@ -192,6 +193,7 @@ pytest my_first_test.py --settings-file=custom_settings.py
192193
--rcs | --reuse-class-session # (Reuse session for tests in class.)
193194
--crumbs # (Delete all cookies between tests reusing a session.)
194195
--disable-beforeunload # (Disable the "beforeunload" event on Chrome.)
196+
--window-position=X,Y # (Set the browser's starting window position.)
195197
--window-size=WIDTH,HEIGHT # (Set the browser's starting window size.)
196198
--maximize # (Start tests with the browser window maximized.)
197199
--screenshot # (Save a screenshot at the end of each test.)
@@ -380,7 +382,7 @@ pytest test_suite.py --dashboard --html=report.html
380382

381383
<img src="https://seleniumbase.github.io/cdn/img/dash_report.jpg" alt="Dashboard Pytest HTML Report" title="Dashboard Pytest HTML Report" width="520" />
382384

383-
If viewing pytest html reports in [Jenkins](https://www.jenkins.io/), you may need to [configure Jenkins settings](https://stackoverflow.com/a/46197356) for the html to render correctly. This is due to [Jenkins CSP changes](https://www.jenkins.io/doc/book/system-administration/security/configuring-content-security-policy/).
385+
If viewing pytest html reports in [Jenkins](https://www.jenkins.io/), you may need to [configure Jenkins settings](https://stackoverflow.com/a/46197356/7058266) for the html to render correctly. This is due to [Jenkins CSP changes](https://www.jenkins.io/doc/book/system-administration/security/configuring-content-security-policy/).
384386

385387
You can also use ``--junit-xml=report.xml`` to get an xml report instead. Jenkins can use this file to display better reporting for your tests.
386388

help_docs/webdriver_installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## [<img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) Installing webdrivers
44

5-
To run web automation, you'll need webdrivers for each browser you plan on using. With SeleniumBase, drivers are downloaded automatically as needed into the SeleniumBase ``drivers`` folder.
5+
To run web automation, you need webdrivers for each browser you plan on using. With SeleniumBase, drivers are downloaded automatically (as needed) into the SeleniumBase `drivers/` folder.
66

77
You can also download drivers manually with these commands:
88

@@ -12,7 +12,7 @@ seleniumbase get geckodriver
1212
seleniumbase get edgedriver
1313
```
1414

15-
After running the commands above, web drivers will get downloaded into the ``seleniumbase/drivers/`` folder. SeleniumBase uses those drivers during tests. (The drivers don't come with SeleniumBase by default.)
15+
After running the commands above, web drivers will get downloaded into the `seleniumbase/drivers/` folder. SeleniumBase uses those drivers during tests. (The drivers don't come with SeleniumBase by default.)
1616

1717
If the necessary driver is not found in this location while running tests, SeleniumBase will instead look for the driver on the System PATH. If the necessary driver is not on the System PATH either, SeleniumBase will automatically attempt to download the required driver.
1818

0 commit comments

Comments
 (0)