Skip to content

Commit 5e5252d

Browse files
committed
Update the docs
1 parent bed4069 commit 5e5252d

File tree

6 files changed

+21
-13
lines changed

6 files changed

+21
-13
lines changed

docs/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ lunr==0.6.0;python_version>="3.6"
2020
nltk==3.6.4;python_version>="3.6"
2121
watchdog==2.1.6;python_version>="3.6"
2222
mkdocs==1.2.2;python_version>="3.6"
23-
mkdocs-material==7.3.0;python_version>="3.6"
23+
mkdocs-material==7.3.1;python_version>="3.6"
2424
mkdocs-exclude-search==0.5.2;python_version>="3.6"
2525
mkdocs-simple-hooks==0.1.3
2626
mkdocs-material-extensions==1.0.3;python_version>="3.6"

examples/ReadMe.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/cdn/img/sb_logo_10t.png" title="SeleniumBase" width="220">](https://github.com/seleniumbase/SeleniumBase/)
1+
[<img src="https://seleniumbase.io/cdn/img/sb_logo_10t.png" title="SeleniumBase" width="240">](https://github.com/seleniumbase/SeleniumBase/)
22

33
<h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Running Example Tests:</h2>
44

help_docs/customizing_test_runs.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/cdn/img/sb_logo_10t.png" title="SeleniumBase" width="220">](https://github.com/seleniumbase/SeleniumBase/)
1+
[<img src="https://seleniumbase.io/cdn/img/sb_logo_10t.png" title="SeleniumBase" width="240">](https://github.com/seleniumbase/SeleniumBase/)
22

33
## pytest options for SeleniumBase
44

help_docs/recorder_mode.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[<img src="https://seleniumbase.io/cdn/img/sb_logo_10t.png" title="SeleniumBase" width="220">](https://github.com/seleniumbase/SeleniumBase/)
1+
[<img src="https://seleniumbase.io/cdn/img/sb_logo_10t.png" title="SeleniumBase" width="240">](https://github.com/seleniumbase/SeleniumBase/)
22

33
<h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Recorder Mode</h2>
44

@@ -12,12 +12,14 @@
1212
pytest TEST_NAME.py --recorder -s
1313
```
1414

15-
🔴 To add your own actions inside the test, you'll need to create a breakpoint inside your test to activate Debug Mode:
15+
🔴 To add manual actions, you'll need to create a breakpoint inside your test to activate "Debug Mode" while in "Recorder Mode": (For reference, "Debug Mode" is also known as the "ipdb debugger".)
1616

1717
```python
1818
import ipdb; ipdb.set_trace()
1919
```
2020

21+
🔴 The Recorder will capture browser actions on URLs that begin with ``https:``, ``http:``, and ``file:``. (The Recorder won't work on ``data:`` URLS.)
22+
2123
🔴 You can also activate Debug Mode at the start of your test by adding ``--trace`` as a ``pytest`` command-line option:
2224

2325
```bash
@@ -58,7 +60,7 @@ class RecorderTest(BaseCase):
5860

5961
<p>🔴 (Note that <b>same domain/origin</b> is not the same as <b>same URL</b>. Example: <code>https://xkcd.com/353/</code> and <code>https://xkcd.com/1537/</code> are two different URLs with the <b>same domain/origin</b>. That means that both URLs will share the same <code>sessionStorage</code> data, and that any changes to <code>sessionStorage</code> from one URL will carry on to the <code>sessionStorage</code> of a different URL when the domain/origin is the same. If you want to find out a website's origin during a test, just call: <code>self.get_origin()</code>, which returns the value of <code>window.location.origin</code> from the browser's console.)</p>
6062

61-
<p>🔴 The launch of Recorder Mode has brought a new SeleniumBase method along with it: <code>self.open_if_not_url(URL)</code>. This method will open the URL given if the browser is not currently on that page. This is used as a method in recorded scripts when SeleniumBase detects that a click action has already brought the test to the given page. This method not only prevents an extra page load if not needed, but it also lets people know the current page of the browser at that point in the test.</p>
63+
<p>🔴 The launch of Recorder Mode has brought a new SeleniumBase method along with it: <code>self.open_if_not_url(URL)</code>. This method will open the URL given if the browser is not currently on that page. This is used as a method in recorded scripts when SeleniumBase detects that a click action has already brought the test to the given page. This method not only prevents an extra page load if not needed, but it also lets people know the current page of the browser during that part of the test.</p>
6264

6365
<p>🔴 SeleniumBase <code>1.66.1</code> adds the ability to record changes to <i>"Choose File"</i> <code>input</code> fields. Sometimes the <i>"Choose File"</i> input field is hidden on websites, so <code>self.show_file_choosers()</code> was added to get around this edge case. Version <code>1.66.1</code> also adds <code>self.set_content_to_frame(frame)</code>, which lets you record actions inside of iframes.</p>
6466

@@ -72,6 +74,8 @@ class RecorderTest(BaseCase):
7274

7375
<p>🔴 SeleniumBase <code>1.66.6</code> adds more selector options and improves the algorithm for converting recorded actions into SeleniumBase code.</p>
7476

77+
<p>🔴 SeleniumBase <code>1.66.7</code> improves Recorder Mode post-processing and automatically adds <code>self.show_file_choosers()</code> if file-upload fields are hidden when calling <code>self.choose_file(selector, file_path)</code>.</p>
78+
7579
--------
7680

7781
<div>To learn more about SeleniumBase, check out the Docs Site:</div>

mkdocs.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ theme:
3232
language: en
3333
include_homepage_in_sidebar: true
3434
sticky_navigation: true
35-
# collapse_navigation: false
35+
collapse_navigation: true
3636
# titles_only: false
3737
include_search_page: false
3838
search_index_only: true
@@ -43,9 +43,10 @@ theme:
4343
- toc.integrate
4444
- navigation.indexes
4545
# - navigation.sections
46-
# - navigation.expand
46+
- navigation.expand
4747
# - navigation.tabs
48-
# - navigation.instant
48+
- navigation.tracking
49+
- navigation.instant
4950
palette:
5051
scheme: default
5152
primary: blue
@@ -59,7 +60,6 @@ theme:
5960
plugins:
6061
- search:
6162
separator: '[\s]+'
62-
prebuild_index: false
6363
lang: en
6464
- exclude-search:
6565
exclude:
@@ -107,9 +107,9 @@ nav:
107107
- MasterQA: examples/master_qa/ReadMe.md
108108
- Jenkins on Azure: integrations/azure/jenkins/ReadMe.md
109109
- Jenkins on Google Cloud: integrations/google_cloud/ReadMe.md
110-
- Katalon Recorder: integrations/katalon/ReadMe.md
111-
- Old Recorder / Export: seleniumbase/utilities/selenium_ide/ReadMe.md
112110
- NodeJS Test Runner: https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/node_js
111+
- Katalon Recorder Export: integrations/katalon/ReadMe.md
112+
- Selenium IDE Export: seleniumbase/utilities/selenium_ide/ReadMe.md
113113
- Help Docs:
114114
- Table of Contents: help_docs/ReadMe.md
115115
- JS Package Manager: help_docs/js_package_manager.md

seleniumbase/console_scripts/ReadMe.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[<img src="https://seleniumbase.io/cdn/img/super_logo_sb.png" title="SeleniumBase" width="290">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
1+
[<img src="https://seleniumbase.io/cdn/img/sb_logo_10t.png" title="SeleniumBase" width="240">](https://github.com/seleniumbase/SeleniumBase/)
22

33
## Console Scripts
44

@@ -345,3 +345,7 @@ You can start, restart, or stop the Grid Hub server.
345345
Controls the Selenium Grid node, which serves as a
346346
worker machine for your Selenium Grid Hub server.
347347
You can start, restart, or stop the Grid node.
348+
349+
--------
350+
351+
[<img src="https://seleniumbase.io/cdn/img/super_logo_sb.png" title="SeleniumBase" width="290">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)

0 commit comments

Comments
 (0)