Skip to content

Commit d8fe78f

Browse files
committed
Update the documentation
1 parent a5f1849 commit d8fe78f

File tree

17 files changed

+116
-114
lines changed

17 files changed

+116
-114
lines changed

.github/Workflows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### <img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> SeleniumBase Workflows
1+
### <img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32" /> SeleniumBase Workflows
22

33
> **Table of Contents / Navigation:**
44
> - [**CI build**](workflows/python-package.yml)

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
<h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> CHANGELOG</h2>
1+
<h2><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32" /> CHANGELOG</h2>
22

33
<h3>See: [SeleniumBase/releases](https://github.com/seleniumbase/SeleniumBase/releases)</h3>

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,9 @@
77
<meta property="og:image" content="https://seleniumbase.github.io/cdn/img/mac_sb_logo_5b.png" />
88
<link rel="icon" href="https://seleniumbase.github.io/img/logo3b.png" />
99

10-
<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/sb_word_cloud.png" alt="SeleniumBase" title="SeleniumBase" width="450" /></a></p>
10+
<h2 align="center"><b>SeleniumBase - Python Web UI Testing Made Easy</b><br /><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></h2>
1111

12-
<h3 align="center"><b>SeleniumBase - Python Web UI Testing Made Easy</b></h3>
13-
14-
<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>
12+
<p align="center"><a href="https://seleniumbase.github.io/cdn/gif/my_first_test_2.gif" target="_blank"><img src="https://seleniumbase.github.io/cdn/gif/my_first_test_2.gif" width="480" alt="SeleniumBase Example" title="SeleniumBase Example" /></a></p>
1513

1614
<p align="center">
1715
<a href="#python_installation">🚀 Start</a> |
@@ -54,7 +52,7 @@
5452
--------
5553

5654
<blockquote>
57-
<p dir="auto"><strong>Table of Contents:</strong></p>
55+
<p dir="auto"><strong>SeleniumBase - Table of Contents:</strong></p>
5856
<ul dir="auto">
5957
<li><a href="#python_installation" ><strong>Set up Python & Git</strong></a></li>
6058
<li><a href="#install_seleniumbase" ><strong>Install SeleniumBase</strong></a></li>
@@ -465,7 +463,7 @@ pytest my_first_test.py --pdb
465463
🔵 Here are some useful command-line options that come with <code>pytest</code>:
466464
467465
```bash
468-
-v # Verbose mode. Prints the full name of each test run.
466+
-v # Verbose mode. Prints the full name of each test and shows more details.
469467
-q # Quiet mode. Print fewer details in the console output when running tests.
470468
-x # Stop running the tests after the first failure is reached.
471469
--html=report.html # Creates a detailed pytest-html report after tests finish.
@@ -554,7 +552,8 @@ pytest my_first_test.py --pdb
554552
--incognito # (Enable Chrome's Incognito mode.)
555553
--guest # (Enable Chrome's Guest mode.)
556554
--devtools # (Open Chrome's DevTools when the browser opens.)
557-
--reuse-session | --rs # (Reuse the browser session between tests.)
555+
--reuse-session | --rs # (Reuse browser session for all tests.)
556+
--reuse-class-session | --rcs # (Reuse session for tests in class.)
558557
--crumbs # (Delete all cookies between tests reusing a session.)
559558
--disable-beforeunload # (Disable the "beforeunload" event on Chrome.)
560559
--window-size=WIDTH,HEIGHT # (Set the browser's starting window size.)

examples/boilerplates/ReadMe.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
<!-- SeleniumBase Docs -->
22

3-
<img src="https://seleniumbase.io/cdn/img/sb_text_f.png" title="SeleniumBase" align="center" width="290">
3+
<img src="https://seleniumbase.github.io/cdn/img/sb_text_f.png" title="SeleniumBase" align="center" width="290">
44

5-
<h2><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Example Boilerplates:</h2>
5+
<h2><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="24" /> Example Boilerplates:</h2>
66

77
* Boilerplate files are located in the [SeleniumBase => examples/boilerplates/](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/boilerplates) folder.
88
* Boilerplates can help you structure tests using common design patterns such as the Page Object Model.
99
* For all 20 SeleniumBase design patterns, see: [Syntax Formats](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/syntax_formats.md)
1010

11-
<h2><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Boilerplate Files:</h2>
11+
<h2><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="24" /> Boilerplate Files:</h2>
1212

1313
* <b>[base_test_case.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/boilerplates/base_test_case.py):</b> This example demonstrates a test class inheriting [BaseCase](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures/base_case.py) for adding new methods.
1414
* <b>[page_objects.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/boilerplates/page_objects.py):</b> This example demonstrates Page Objects for reusing commonly-used selectors in tests.
@@ -17,4 +17,4 @@
1717

1818
--------
1919

20-
<div><a href="https://github.com/seleniumbase/SeleniumBase"><img src="https://seleniumbase.io/cdn/img/sb_logo_gs.png" alt="SeleniumBase" width="300" /></a></div>
20+
<div><a href="https://github.com/seleniumbase/SeleniumBase"><img src="https://seleniumbase.github.io/cdn/img/sb_logo_gs.png" alt="SeleniumBase" width="300" /></a></div>

examples/chart_maker/ReadMe.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<!-- SeleniumBase Docs -->
22

3-
## [<img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) 📊 ChartMaker 📶
3+
## [<img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) 📊 ChartMaker 📶
44

55
<p>SeleniumBase ChartMaker lets you use Python to generate HTML charts.</p>
66

7-
<a href="https://seleniumbase.io/other/chart_presentation.html"><img width="480" src="https://seleniumbase.io/cdn/gif/chart_pres.gif" title="Chart Presentation"></a><br>
7+
<a href="https://seleniumbase.io/other/chart_presentation.html"><img width="480" src="https://seleniumbase.github.io/cdn/gif/chart_pres.gif" title="Chart Presentation"></a><br>
88

99
([Click to see a presentation with multiple charts](https://seleniumbase.io/other/chart_presentation.html))
1010

@@ -40,20 +40,20 @@ pytest chart_presentation.py
4040

4141
Here are screenshots from the examples:
4242

43-
<a href="https://seleniumbase.io/other/chart_presentation.html"><img width="500" src="https://seleniumbase.io/other/sample_pie_chart.png" title="Screenshot"></a><br>
43+
<a href="https://seleniumbase.github.io/other/chart_presentation.html"><img width="500" src="https://seleniumbase.github.io/other/sample_pie_chart.png" title="Screenshot"></a><br>
4444

45-
<a href="https://seleniumbase.io/other/sample_column_chart.png"><img width="500" src="https://seleniumbase.io/other/sample_column_chart.png" title="Screenshot"></a><br>
45+
<a href="https://seleniumbase.github.io/other/sample_column_chart.png"><img width="500" src="https://seleniumbase.github.io/other/sample_column_chart.png" title="Screenshot"></a><br>
4646

47-
<a href="https://seleniumbase.io/other/sample_bar_chart.png"><img width="500" src="https://seleniumbase.io/other/sample_bar_chart.png" title="Screenshot"></a><br>
47+
<a href="https://seleniumbase.github.io/other/sample_bar_chart.png"><img width="500" src="https://seleniumbase.github.io/other/sample_bar_chart.png" title="Screenshot"></a><br>
4848

49-
<a href="https://seleniumbase.io/other/sample_line_chart.png"><img width="500" src="https://seleniumbase.io/other/sample_line_chart.png" title="Screenshot"></a><br>
49+
<a href="https://seleniumbase.github.io/other/sample_line_chart.png"><img width="500" src="https://seleniumbase.github.io/other/sample_line_chart.png" title="Screenshot"></a><br>
5050

51-
<a href="https://seleniumbase.io/other/sample_area_chart.png"><img width="500" src="https://seleniumbase.io/other/sample_area_chart.png" title="Screenshot"></a><br>
51+
<a href="https://seleniumbase.github.io/other/sample_area_chart.png"><img width="500" src="https://seleniumbase.github.io/other/sample_area_chart.png" title="Screenshot"></a><br>
5252

53-
<a href="https://seleniumbase.io/other/multi_series_chart.png"><img width="500" src="https://seleniumbase.io/other/multi_series_chart.png" title="Screenshot"></a><br>
53+
<a href="https://seleniumbase.github.io/other/multi_series_chart.png"><img width="500" src="https://seleniumbase.github.io/other/multi_series_chart.png" title="Screenshot"></a><br>
5454

5555

56-
<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Here's a line chart example:</h3>
56+
<h3><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32" /> Here's a line chart example:</h3>
5757

5858
```python
5959
from seleniumbase import BaseCase
@@ -83,7 +83,7 @@ pytest test_line_chart.py
8383
Because that presentation above has an ``interval`` set to ``8``, it will automatically advance to the next slide after 8 seconds. (Or exit if there are no more slides.)
8484

8585

86-
<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> For a more advanced example (multiple charts in a presentation):</h3>
86+
<h3><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32" /> For a more advanced example (multiple charts in a presentation):</h3>
8787

8888
```python
8989
from seleniumbase import BaseCase
@@ -138,7 +138,7 @@ pytest chart_presentation.py
138138
Multi-Series charts can also be created. Try the available examples to learn more.
139139

140140

141-
<h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> ChartMaker API</h2>
141+
<h2><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32" /> ChartMaker API</h2>
142142

143143
```python
144144
self.create_pie_chart(
@@ -260,7 +260,7 @@ self.create_area_chart(
260260
If creating multiple charts at the same time, you can pass the ``chart_name`` parameter to distinguish between different charts.
261261

262262

263-
<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Adding a data point to a chart:</h3>
263+
<h3><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32" /> Adding a data point to a chart:</h3>
264264

265265
```python
266266
self.add_data_point(label, value, color=None, chart_name=None):
@@ -277,7 +277,7 @@ self.add_data_point(label, value, color=None, chart_name=None):
277277
```
278278

279279

280-
<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Adding a new data series to an existing chart:</h3>
280+
<h3><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32" /> Adding a new data series to an existing chart:</h3>
281281

282282
```python
283283
self.add_series_to_chart(self, data_name=None, chart_name=None):
@@ -291,7 +291,7 @@ self.add_series_to_chart(self, data_name=None, chart_name=None):
291291
```
292292

293293

294-
<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Saving a chart to a file:</h3>
294+
<h3><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32" /> Saving a chart to a file:</h3>
295295

296296
```python
297297
self.save_chart(chart_name=None, filename=None):
@@ -307,7 +307,7 @@ self.save_chart(chart_name=None, filename=None):
307307
The full HTML of the chart is saved to the ``saved_charts/`` folder.
308308

309309

310-
<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Extracting the HTML of a chart:</h3>
310+
<h3><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32" /> Extracting the HTML of a chart:</h3>
311311

312312
```python
313313
self.extract_chart(chart_name=None):
@@ -319,7 +319,7 @@ self.extract_chart(chart_name=None):
319319
```
320320

321321

322-
<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Displaying a chart in the browser window:</h3>
322+
<h3><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32" /> Displaying a chart in the browser window:</h3>
323323

324324
```python
325325
self.display_chart(chart_name=None, filename=None):

examples/desktop_apps/ReadMe.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
<h3 align="left"><img src="https://seleniumbase.io/cdn/img/sb_logo_b.png" alt="SeleniumBase" width="320" /></h3>
1+
<h3 align="left"><img src="https://seleniumbase.github.io/cdn/img/sb_logo_b.png" alt="SeleniumBase" width="320" /></h3>
22

3-
<h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Desktop Apps</h2>
3+
<h2><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32" /> Desktop Apps</h2>
44

55
* **Recorder** (Run using ``python recorder.py`` or ``sbase recorder``)

examples/presenter/ReadMe.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<b>Here's a sample presentation:</b>
88

9-
<a href="https://seleniumbase.github.io/other/presenter.html"><img width="500" src="https://seleniumbase.io/other/presenter.gif" title="Screenshot"></a><br>
9+
<a href="https://seleniumbase.github.io/other/presenter.html"><img width="500" src="https://seleniumbase.github.io/other/presenter.gif" title="Screenshot"></a><br>
1010

1111
([Click on the image/GIF for the actual presentation](https://seleniumbase.io/other/presenter.html))
1212

@@ -23,7 +23,7 @@ pytest my_presentation.py
2323

2424
**Here's a presentation with a chart:**
2525

26-
<a href="https://seleniumbase.github.io/other/core_presentation.html"><img width="428" src="https://seleniumbase.io/other/sb_core_areas.png" title="Screenshot"></a><br>
26+
<a href="https://seleniumbase.github.io/other/core_presentation.html"><img width="428" src="https://seleniumbase.github.io/other/sb_core_areas.png" title="Screenshot"></a><br>
2727

2828
([Click on the image/GIF for the actual presentation](https://seleniumbase.io/other/core_presentation.html))
2929

@@ -150,7 +150,7 @@ class MyPresenterClass(BaseCase):
150150
)
151151
self.add_slide(
152152
'<h3>Add <b>images</b> to slides:</h3>',
153-
image="https://seleniumbase.io/other/seagulls.jpg")
153+
image="https://seleniumbase.github.io/other/seagulls.jpg")
154154
self.add_slide(
155155
'<h3>Add <b>code</b> to slides:</h3>',
156156
code=(
@@ -220,7 +220,7 @@ class MyPresenterClass(BaseCase):
220220
'self.create_presentation(theme="league")'))
221221
self.add_slide(
222222
'<h2><b>The End</b></h2>',
223-
image="https://seleniumbase.io/img/sb_logo_10.png")
223+
image="https://seleniumbase.github.io/img/sb_logo_10.png")
224224
self.begin_presentation(
225225
filename="presenter.html", show_notes=True, interval=0)
226226
```

examples/tour_examples/ReadMe.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<h3 align="left"><img src="https://seleniumbase.github.io/cdn/img/g_maps_tour.png" alt="SeleniumBase Tour" width="340" /></h3>
44

5-
## [<img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) Interactive Product Tours 🚎
5+
## [<img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) Interactive Product Tours 🚎
66

77
<p><b>Increase SaaS Product Adoption by 10x or more.</b></p>
88

examples/translations/ReadMe.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<a id="language_tests"></a>
22

3-
## [<img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) 🌏 Translated Tests 🈺
3+
## [<img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) 🌏 Translated Tests 🈺
44

55
<b>SeleniumBase</b> supports the following 10 languages: <i>English</i>, <i>Chinese</i>, <i>Dutch</i>, <i>French</i>, <i>Italian</i>, <i>Japanese</i>, <i>Korean</i>, <i>Portuguese</i>, <i>Russian</i>, and <i>Spanish</i>. (Examples can be found in <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/translations">SeleniumBase/examples/translations</a>)
66

@@ -39,7 +39,7 @@ class 私のテストクラス(セレニウムテストケース):
3939
```
4040

4141
<a id="translation_api"></a>
42-
<h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Translation API 🈺</h2>
42+
<h2><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32" /> Translation API 🈺</h2>
4343

4444
You can use SeleniumBase to selectively translate the method names of any test from one language to another with the console scripts interface. Additionally, the ``import`` line at the top of the Python file will change to import the new ``BaseCase``. Example: ``BaseCase`` becomes ``CasoDeTeste`` when a test is translated into Portuguese.
4545

@@ -88,4 +88,4 @@ plus the 2-letter language code of the new language.
8888

8989
--------
9090

91-
<h3 align="left"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.io/cdn/img/super_logo_m.png" title="SeleniumBase" width="280" /></a></h3>
91+
<h3 align="left"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/super_logo_m.png" title="SeleniumBase" width="280" /></a></h3>

0 commit comments

Comments
 (0)