Skip to content

Commit ba8f555

Browse files
mdmintzmdmintz
committed
Update the docs
1 parent 64273f8 commit ba8f555

File tree

2 files changed

+24
-24
lines changed

2 files changed

+24
-24
lines changed

‎examples/example_logs/ReadMe.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,25 @@
1-
### <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> **Logging, Screenshots, and Reports:**
1+
### <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3.png" title="SeleniumBase" height="32"> Logging, Screenshots, and Reports:
22

3-
Log files in [example_logs/](https://github.com/seleniumbase/SeleniumBase/tree/master/examples/example_logs) were generated when [test_fail.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_fail.py) ran and failed. During test failures, logs and screenshots get saved to the ``latest_logs/`` folder. If ``--archive-logs`` is set, test logs will get archived to the ``archived_logs/`` folder.
3+
Log files in [SeleniumBase/examples/example_logs](https://github.com/seleniumbase/SeleniumBase/tree/master/examples/example_logs) were generated when [test_fail.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_fail.py) ran and failed. During test failures, logs and screenshots get saved to the ``latest_logs/`` folder. If ``--archive-logs`` is set, test logs will get archived to the ``archived_logs/`` folder.
44

55
```bash
66
pytest test_fail.py --browser=chrome
77

88
nosetests test_fail.py --browser=firefox
99
```
1010

11-
**Expected log files generated during failures:**
11+
<b>Examples of expected log files generated during failures:</b>
1212
* [basic_test_info.txt](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/basic_test_info.txt)
1313
* [page_source.html](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/page_source.html)
1414
* [screenshot.png](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/screenshot.png)
1515

16-
---
17-
**In addition to logging, you can also generate test reports:**
16+
--------
17+
18+
<b>In addition to logging, you can also generate test reports:</b>
1819

1920
Reports are most useful when running large test suites. Pytest and Nosetest reports are handled differently.
2021

21-
#### **Pytest Reports:**
22+
### Pytest Reports:
2223

2324
Using ``--html=report.html`` gives you a fancy report of the name specified after your test suite completes.
2425

@@ -27,7 +28,7 @@ pytest test_suite.py --html=report.html
2728
```
2829
![](https://cdn2.hubspot.net/hubfs/100006/images/PytestReport.png "Example Pytest Report")
2930

30-
#### **Nosetest Reports:**
31+
### Nosetest Reports:
3132

3233
The ``--report`` option gives you a fancy report after your test suite completes. (Requires ``--with-testing_base`` to also be set when ``--report`` is used because it's part of that plugin.)
3334

‎help_docs/ReadMe.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
11
<div><a href="https://github.com/seleniumbase/SeleniumBase"><img src="https://cdn2.hubspot.net/hubfs/100006/images/sb_media_logo.png" alt="SeleniumBase" height="114" /></a></div>
2-
<div><a href="https://github.com/seleniumbase/SeleniumBase"><img src="https://cdn2.hubspot.net/hubfs/100006/images/SB_Logo4d4.png" alt="SeleniumBase" height="50" /></a></div>
32

43
## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3.png" title="SeleniumBase" height="32"> Help Documents
54

65
<div><b>Table of Contents / Navigation:</b></div>
7-
<div><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md"><b>SeleniumBase Features List</b></a></div>
8-
<div><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/how_it_works.md"><b>How SeleniumBase Works</b></a></div>
9-
<div><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/install_python_pip_git.md"><b>Installing Python, Pip, & Git</b></a></div>
10-
<div><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/virtualenv_instructions.md"><b>Python Virtual Env Tutorial</b></a></div>
11-
<div><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/install.md"><b>SeleniumBase Installation</b></a></div>
12-
<div><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/webdriver_installation.md"><b>Webdriver Installation</b></a></div>
13-
<div><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/verify_webdriver.md"><b>Verify Webdriver Installation</b></a></div>
14-
<div><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md"><b>The Command Line Tutorial</b></a></div>
15-
<div><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/console_scripts/ReadMe.md"><b>The Console Scripts Tutorial</b></a></div>
16-
<div><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/mobile_testing.md"><b>Mobile Device Testing</b></a></div>
17-
<div><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md"><b>Method Summary Overview</b></a></div>
18-
<div><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/mobile_testing.md"><b>SeleniumBase Translations</b></a></div>
19-
<div><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/mysql_installation.md"><b>MySQL Installation Overview</b></a></div>
20-
<div><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/using_safari_driver.md"><b>Safari Driver Detailed Info</b></a></div>
21-
<div><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/hidden_files_info.md"><b>Seeing Hidden Files on macOS</b></a></div>
22-
<div><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/happy_customers.md"><b>SeleniumBase Case Studies</b></a></div>
6+
<div><a href="https://seleniumbase.io/help_docs/features_list/"><b>SeleniumBase Features List</b></a></div>
7+
<div><a href="https://seleniumbase.io/help_docs/how_it_works/"><b>How SeleniumBase Works</b></a></div>
8+
<div><a href="https://seleniumbase.io/help_docs/install_python_pip_git/"><b>Installing Python, Pip, & Git</b></a></div>
9+
<div><a href="https://seleniumbase.io/help_docs/virtualenv_instructions/"><b>Python Virtual Env Tutorial</b></a></div>
10+
<div><a href="https://seleniumbase.io/help_docs/install/"><b>SeleniumBase Installation</b></a></div>
11+
<div><a href="https://seleniumbase.io/help_docs/webdriver_installation/"><b>Webdriver Installation</b></a></div>
12+
<div><a href="https://seleniumbase.io/help_docs/verify_webdriver/"><b>Verify Webdriver Installation</b></a></div>
13+
<div><a href="https://seleniumbase.io/help_docs/customizing_test_runs/"><b>The Command Line Tutorial</b></a></div>
14+
<div><a href="https://seleniumbase.io/seleniumbase/console_scripts/ReadMe/"><b>The Console Scripts Tutorial</b></a></div>
15+
<div><a href="https://seleniumbase.io/help_docs/mobile_testing/"><b>Mobile Device Testing</b></a></div>
16+
<div><a href="https://seleniumbase.io/help_docs/method_summary/"><b>Method Summary Overview</b></a></div>
17+
<div><a href="https://seleniumbase.io/help_docs/mobile_testing/"><b>SeleniumBase Translations</b></a></div>
18+
<div><a href="https://seleniumbase.io/help_docs/mysql_installation/"><b>MySQL Installation Overview</b></a></div>
19+
<div><a href="https://seleniumbase.io/help_docs/using_safari_driver/"><b>Safari Driver Detailed Info</b></a></div>
20+
<div><a href="https://seleniumbase.io/help_docs/hidden_files_info/"><b>Seeing Hidden Files on macOS</b></a></div>
21+
<div><a href="https://seleniumbase.io/help_docs/happy_customers/"><b>SeleniumBase Case Studies</b></a></div>

0 commit comments

Comments
 (0)