test_framework
/
SeleniumBase
mirror of https://github.com/seleniumbase/SeleniumBase.git
3
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update the documentation

This commit is contained in:
Michael Mintz 2023-02-17 23:53:47 -05:00
parent 0288f5ef13
commit 6c91d14e89
3 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
help_docs/how_it_works.md
View File

@ -24,6 +24,7 @@ Here's what a full test might look like:
```python ```python
from seleniumbase import BaseCase from seleniumbase import BaseCase
BaseCase.main(__name__, __file__)
class TestMFALogin(BaseCase): class TestMFALogin(BaseCase):
def test_mfa_login(self): def test_mfa_login(self):
@ -75,9 +76,7 @@ pytest -k agent
* ``--sjw`` --> Skip JS Waits, which include ``wait_for_ready_state_complete()`` and ``wait_for_angularjs()``. * ``--sjw`` --> Skip JS Waits, which include ``wait_for_ready_state_complete()`` and ``wait_for_angularjs()``.
(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.)
-------- --------
<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> <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>
<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> <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>

10
help_docs/install.md
View File

@ -2,19 +2,19 @@
## [<img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) SeleniumBase Installation ## [<img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) SeleniumBase Installation
<h4>If installing SeleniumBase directly from <a href="https://pypi.python.org/pypi/seleniumbase">PyPI</a>, (the Python Package Index), use:</h4> <h4>If installing <code>seleniumbase</code> directly from <a href="https://pypi.python.org/pypi/seleniumbase">PyPI</a>, (the Python Package Index), use:</h4>
```bash ```bash
pip install seleniumbase pip install seleniumbase
``` ```
<h4>To upgrade an existing <code>seleniumbase<code> install from PyPI:</h4> <h4>To upgrade an existing <code>seleniumbase</code> install from PyPI:</h4>
```bash ```bash
pip install -U seleniumbase pip install -U seleniumbase
``` ```
<h4>If installing SeleniumBase from a Git clone, use:</h4> <h4>If installing <code>seleniumbase</code> from a Git clone, use:</h4>
```bash ```bash
git clone https://github.com/seleniumbase/SeleniumBase.git git clone https://github.com/seleniumbase/SeleniumBase.git
@ -37,7 +37,7 @@ git pull # To pull the latest version
pip install -e . # Or "pip install ." pip install -e . # Or "pip install ."
``` ```
<h4>If installing SeleniumBase from a <a href="https://github.com/seleniumbase/SeleniumBase">GitHub branch</a>, use:</h4> <h4>If installing <code>seleniumbase</code> from a <a href="https://github.com/seleniumbase/SeleniumBase">GitHub branch</a>, use:</h4>
```bash ```bash
pip install git+https://github.com/seleniumbase/SeleniumBase.git@master#egg=seleniumbase 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
-------- --------
[<img src="https://seleniumbase.github.io/cdn/img/sb_logo_10t.png" title="SeleniumBase" width="290">](https://github.com/seleniumbase/SeleniumBase/) [<img src="https://seleniumbase.github.io/cdn/img/sb_logo_10t.png" title="SeleniumBase" width="290" />](https://github.com/seleniumbase/SeleniumBase/)

4
mkdocs_build/requirements.txt
View File

@ -15,7 +15,7 @@ ghp-import==2.1.0
readme-renderer==37.3 readme-renderer==37.3
pymdown-extensions==9.9.2 pymdown-extensions==9.9.2
importlib-metadata==6.0.0 importlib-metadata==6.0.0
pipdeptree==2.3.3 pipdeptree==2.4.0
bleach==6.0.0 bleach==6.0.0
lunr==0.6.2 lunr==0.6.2
nltk==3.8.1 nltk==3.8.1
@ -27,7 +27,7 @@ cssselect2==0.7.0
tinycss2==1.2.1 tinycss2==1.2.1
defusedxml==0.7.1 defusedxml==0.7.1
mkdocs==1.4.2 mkdocs==1.4.2
mkdocs-material==9.0.11 mkdocs-material==9.0.12
mkdocs-exclude-search==0.6.5 mkdocs-exclude-search==0.6.5
mkdocs-simple-hooks==0.1.5 mkdocs-simple-hooks==0.1.5
mkdocs-material-extensions==1.1.1 mkdocs-material-extensions==1.1.1