Skip to content

Commit 6c91d14

Browse files
committed
Update the documentation
1 parent 0288f5e commit 6c91d14

File tree

3 files changed

+9
-10
lines changed

3 files changed

+9
-10
lines changed

help_docs/how_it_works.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Here's what a full test might look like:
2424

2525
```python
2626
from seleniumbase import BaseCase
27+
BaseCase.main(__name__, __file__)
2728

2829
class TestMFALogin(BaseCase):
2930
def test_mfa_login(self):
@@ -75,9 +76,7 @@ pytest -k agent
7576

7677
* ``--sjw`` --> Skip JS Waits, which include ``wait_for_ready_state_complete()`` and ``wait_for_angularjs()``.
7778

78-
(NOTE: Those command-line options were added in SeleniumBase ``4.2.0``. Using both could lead to a 15% increase in test speed, but it could also lead to flaky tests, so use with caution.)
79-
8079
--------
8180

82-
<p><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.io/cdn/img/super_logo_sb.png" alt="SeleniumBase" title="SeleniumBase" width="300" /></a></p>
81+
<p><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/super_logo_sb.png" alt="SeleniumBase" title="SeleniumBase" width="300" /></a></p>
8382
<p><a href="https://www.python.org/downloads/" target="_blank"><img src="https://img.shields.io/pypi/pyversions/seleniumbase.svg?color=22AAEE&logo=python" title="Supported Python Versions" /></a></p>

help_docs/install.md

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

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

5-
<h4>If installing SeleniumBase directly from <a href="https://pypi.python.org/pypi/seleniumbase">PyPI</a>, (the Python Package Index), use:</h4>
5+
<h4>If installing <code>seleniumbase</code> directly from <a href="https://pypi.python.org/pypi/seleniumbase">PyPI</a>, (the Python Package Index), use:</h4>
66

77
```bash
88
pip install seleniumbase
99
```
1010

11-
<h4>To upgrade an existing <code>seleniumbase<code> install from PyPI:</h4>
11+
<h4>To upgrade an existing <code>seleniumbase</code> install from PyPI:</h4>
1212

1313
```bash
1414
pip install -U seleniumbase
1515
```
1616

17-
<h4>If installing SeleniumBase from a Git clone, use:</h4>
17+
<h4>If installing <code>seleniumbase</code> from a Git clone, use:</h4>
1818

1919
```bash
2020
git clone https://github.com/seleniumbase/SeleniumBase.git
@@ -37,7 +37,7 @@ git pull # To pull the latest version
3737
pip install -e . # Or "pip install ."
3838
```
3939

40-
<h4>If installing SeleniumBase from a <a href="https://github.com/seleniumbase/SeleniumBase">GitHub branch</a>, use:</h4>
40+
<h4>If installing <code>seleniumbase</code> from a <a href="https://github.com/seleniumbase/SeleniumBase">GitHub branch</a>, use:</h4>
4141

4242
```bash
4343
pip install git+https://github.com/seleniumbase/SeleniumBase.git@master#egg=seleniumbase
@@ -53,4 +53,4 @@ pip install git+https://github.com/seleniumbase/SeleniumBase.git@master#egg=sele
5353

5454
--------
5555

56-
[<img src="https://seleniumbase.github.io/cdn/img/sb_logo_10t.png" title="SeleniumBase" width="290">](https://github.com/seleniumbase/SeleniumBase/)
56+
[<img src="https://seleniumbase.github.io/cdn/img/sb_logo_10t.png" title="SeleniumBase" width="290" />](https://github.com/seleniumbase/SeleniumBase/)

mkdocs_build/requirements.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ghp-import==2.1.0
1515
readme-renderer==37.3
1616
pymdown-extensions==9.9.2
1717
importlib-metadata==6.0.0
18-
pipdeptree==2.3.3
18+
pipdeptree==2.4.0
1919
bleach==6.0.0
2020
lunr==0.6.2
2121
nltk==3.8.1
@@ -27,7 +27,7 @@ cssselect2==0.7.0
2727
tinycss2==1.2.1
2828
defusedxml==0.7.1
2929
mkdocs==1.4.2
30-
mkdocs-material==9.0.11
30+
mkdocs-material==9.0.12
3131
mkdocs-exclude-search==0.6.5
3232
mkdocs-simple-hooks==0.1.5
3333
mkdocs-material-extensions==1.1.1

0 commit comments

Comments
 (0)