Skip to content

Commit 64273f8

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

File tree

9 files changed

+263
-39
lines changed

9 files changed

+263
-39
lines changed

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<meta property="og:title" content="SeleniumBase" />
2-
<meta property="og:description" content="Create Web UI tests, fast!" />
2+
<meta property="og:description" content="Create browser tests for web and mobile user interfaces." />
33
<meta property="og:image" content="https://cdn2.hubspot.net/hubfs/100006/images/big_blue_logo_7.png" />
44
<link rel="icon" href="https://seleniumbase.io/img/favicon.ico">
55
<h2 align="center"><a align="center" href="https://github.com/seleniumbase/SeleniumBase/"><img align="center" src="https://cdn2.hubspot.net/hubfs/100006/images/blue_logo_7.png" alt="SeleniumBase" height="170"></a></h2>

‎docs/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,5 @@ mkdocs==1.1.2
22
mkdocs-material==5.0.2
33
mkdocs-simple-hooks==0.1.0
44
mkdocs-material-extensions==1.0
5+
mkdocs-minify-plugin==0.3.0
6+
fontawesome_markdown==0.2.6

‎docs/sitemap.xml

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<urlset
3+
xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
4+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5+
xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9
6+
http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd">
7+
<!-- created with Free Online Sitemap Generator www.xml-sitemaps.com -->
8+
9+
10+
<url>
11+
<loc>https://seleniumbase.io/</loc>
12+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
13+
<priority>1.00</priority>
14+
</url>
15+
<url>
16+
<loc>https://seleniumbase.io/.</loc>
17+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
18+
<priority>0.80</priority>
19+
</url>
20+
<url>
21+
<loc>https://seleniumbase.io/help_docs/features_list/</loc>
22+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
23+
<priority>0.80</priority>
24+
</url>
25+
<url>
26+
<loc>https://seleniumbase.io/help_docs/customizing_test_runs/</loc>
27+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
28+
<priority>0.80</priority>
29+
</url>
30+
<url>
31+
<loc>https://seleniumbase.io/examples/ReadMe/</loc>
32+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
33+
<priority>0.80</priority>
34+
</url>
35+
<url>
36+
<loc>https://seleniumbase.io/help_docs/translations/</loc>
37+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
38+
<priority>0.80</priority>
39+
</url>
40+
<url>
41+
<loc>https://seleniumbase.io/examples/example_logs/ReadMe/</loc>
42+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
43+
<priority>0.80</priority>
44+
</url>
45+
<url>
46+
<loc>https://seleniumbase.io/help_docs/method_summary/</loc>
47+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
48+
<priority>0.80</priority>
49+
</url>
50+
<url>
51+
<loc>https://seleniumbase.io/help_docs/mobile_testing/</loc>
52+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
53+
<priority>0.80</priority>
54+
</url>
55+
<url>
56+
<loc>https://seleniumbase.io/seleniumbase/console_scripts/ReadMe/</loc>
57+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
58+
<priority>0.80</priority>
59+
</url>
60+
<url>
61+
<loc>https://seleniumbase.io/examples/tour_examples/ReadMe/</loc>
62+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
63+
<priority>0.80</priority>
64+
</url>
65+
<url>
66+
<loc>https://seleniumbase.io/help_docs/how_it_works/</loc>
67+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
68+
<priority>0.80</priority>
69+
</url>
70+
<url>
71+
<loc>https://seleniumbase.io/help_docs/install_python_pip_git/</loc>
72+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
73+
<priority>0.80</priority>
74+
</url>
75+
<url>
76+
<loc>https://seleniumbase.io/help_docs/virtualenv_instructions/</loc>
77+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
78+
<priority>0.80</priority>
79+
</url>
80+
<url>
81+
<loc>https://seleniumbase.io/help_docs/install/</loc>
82+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
83+
<priority>0.80</priority>
84+
</url>
85+
<url>
86+
<loc>https://seleniumbase.io/help_docs/webdriver_installation/</loc>
87+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
88+
<priority>0.80</priority>
89+
</url>
90+
<url>
91+
<loc>https://seleniumbase.io/help_docs/verify_webdriver/</loc>
92+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
93+
<priority>0.80</priority>
94+
</url>
95+
<url>
96+
<loc>https://seleniumbase.io/seleniumbase/utilities/selenium_ide/ReadMe/</loc>
97+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
98+
<priority>0.80</priority>
99+
</url>
100+
<url>
101+
<loc>https://seleniumbase.io/examples/master_qa/ReadMe/</loc>
102+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
103+
<priority>0.80</priority>
104+
</url>
105+
<url>
106+
<loc>https://seleniumbase.io/examples/visual_testing/ReadMe/</loc>
107+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
108+
<priority>0.80</priority>
109+
</url>
110+
<url>
111+
<loc>https://seleniumbase.io/integrations/github/workflows/ReadMe/</loc>
112+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
113+
<priority>0.80</priority>
114+
</url>
115+
<url>
116+
<loc>https://seleniumbase.io/help_docs/happy_customers/</loc>
117+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
118+
<priority>0.80</priority>
119+
</url>
120+
<url>
121+
<loc>https://seleniumbase.io/help_docs/mysql_installation/</loc>
122+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
123+
<priority>0.80</priority>
124+
</url>
125+
<url>
126+
<loc>https://seleniumbase.io/help_docs/using_safari_driver/</loc>
127+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
128+
<priority>0.80</priority>
129+
</url>
130+
<url>
131+
<loc>https://seleniumbase.io/help_docs/hidden_files_info/</loc>
132+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
133+
<priority>0.80</priority>
134+
</url>
135+
<url>
136+
<loc>https://seleniumbase.io/integrations/azure/jenkins/ReadMe/</loc>
137+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
138+
<priority>0.80</priority>
139+
</url>
140+
<url>
141+
<loc>https://seleniumbase.io/integrations/google_cloud/ReadMe/</loc>
142+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
143+
<priority>0.80</priority>
144+
</url>
145+
<url>
146+
<loc>https://seleniumbase.io/integrations/katalon/ReadMe/</loc>
147+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
148+
<priority>0.80</priority>
149+
</url>
150+
<url>
151+
<loc>https://seleniumbase.io/seleniumbase/common/ReadMe/</loc>
152+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
153+
<priority>0.80</priority>
154+
</url>
155+
<url>
156+
<loc>https://seleniumbase.io/seleniumbase/utilities/selenium_grid/ReadMe/</loc>
157+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
158+
<priority>0.80</priority>
159+
</url>
160+
<url>
161+
<loc>https://seleniumbase.io/integrations/docker/ReadMe/</loc>
162+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
163+
<priority>0.80</priority>
164+
</url>
165+
<url>
166+
<loc>https://seleniumbase.io/seleniumbase/masterqa/ReadMe/</loc>
167+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
168+
<priority>0.80</priority>
169+
</url>
170+
<url>
171+
<loc>https://seleniumbase.io/help_docs/ReadMe/</loc>
172+
<lastmod>2020-05-15T07:02:39+00:00</lastmod>
173+
<priority>0.80</priority>
174+
</url>
175+
176+
177+
</urlset>

‎help_docs/how_it_works.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_sb4.png" title="SeleniumBase" height="48">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
22

33
<a id="how_seleniumbase_works"></a>
4-
## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> **How it works:**
4+
## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3.png" title="SeleniumBase" height="32"> **How it works:**
55

6-
At the core, SeleniumBase works by extending [pytest](https://docs.pytest.org/en/latest/) and [nosetests](http://nose.readthedocs.io/en/latest/) as a direct plugin to each one. SeleniumBase automatically spins up web browsers for tests, and then gives those tests access to the SeleniumBase libraries through the [BaseCase class](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures/base_case.py). Tests are also given access to SeleniumBase [command-line arguments](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/plugins/pytest_plugin.py), which provide additional functionality.
6+
At the core, SeleniumBase works by extending [pytest](https://docs.pytest.org/en/latest/) as a direct plugin. SeleniumBase automatically spins up web browsers for tests, and then gives those tests access to the SeleniumBase libraries through the [BaseCase class](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures/base_case.py). Tests are also given access to [SeleniumBase command-line arguments](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/plugins/pytest_plugin.py) and [SeleniumBase methods](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md), which provide additional functionality.
77

8-
(NOTE: pytest and nosetests use a feature called test discovery to automatically find and run Python methods that start with "``test_``" from the file that you specified on the command line.)
8+
(NOTE: pytest uses a feature called test discovery to automatically find and run Python methods that start with "``test_``" from the file that you specified on the command line.)
99

1010
To use SeleniumBase calls you need the following:
1111
```python

‎help_docs/install.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_sb4.png" title="SeleniumBase" height="48">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
22

3-
## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Installation
3+
## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3.png" title="SeleniumBase" height="32"> Installation
44

5-
If you're installing SeleniumBase from a cloned copy on your machine, use:
6-
```
5+
If installing SeleniumBase from a Git clone, use:
6+
```bash
7+
git clone https://github.com/seleniumbase/SeleniumBase.git
8+
cd SeleniumBase/
79
pip install -r requirements.txt
8-
910
python setup.py install
1011
```
1112

12-
If you're installing SeleniumBase directly [from PyPI (the Python Package Index)](https://pypi.python.org/pypi/seleniumbase), use:
13+
If installing SeleniumBase directly [from PyPI (the Python Package Index)](https://pypi.python.org/pypi/seleniumbase), use:
1314
```bash
1415
pip install seleniumbase
1516
```
1617

17-
If you're installing SeleniumBase [from a GitHub branch](https://github.com/seleniumbase/SeleniumBase), use:
18+
If installing SeleniumBase [from a GitHub branch](https://github.com/seleniumbase/SeleniumBase), use:
1819
```bash
1920
pip install git+https://github.com/seleniumbase/SeleniumBase.git@master#egg=seleniumbase
2021
```
@@ -23,4 +24,4 @@ Useful ``pip`` options include:
2324
* Add ``--upgrade`` OR ``-U`` to upgrade an installation.
2425
* Add ``--force-reinstall`` for a clean install.
2526

26-
(If you're not using a virtual environment, you may need to add ``--user`` to your ``pip`` command if you're getting errors during installation.)
27+
(If you're not using a virtual environment, you may need to add ``--user`` to your ``pip`` command if you're seeing errors during installation.)

‎help_docs/using_safari_driver.md

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

33
*(NOTE: Safari's WebDriver requires macOS 10.13 "High Sierra" or later.)*
44

5-
You can find the official Apple documentation regarding "Testing with WebDriver in Safari" on the following page: https://developer.apple.com/documentation/webkit/testing_with_webdriver_in_safari
5+
You can find the official Apple documentation regarding "Testing with WebDriver in Safari" on the following page: [https://developer.apple.com/documentation/webkit/testing_with_webdriver_in_safari](https://developer.apple.com/documentation/webkit/testing_with_webdriver_in_safari)
66

77
Run ``safaridriver --enable`` once in a terminal to enable Safari's WebDriver. (If you’re upgrading from a previous macOS release, you may need to prefix the command with ``sudo``.)
88

‎help_docs/virtualenv_instructions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Virtual Environment Tutorial
1+
## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3.png" title="SeleniumBase" height="32"> Virtual Environment Tutorial
22

3-
### **Step 1**: Install VirtualEnv and VirtualEnvWrapper:
3+
### Step 1: Install VirtualEnv and VirtualEnvWrapper:
44

55
### macOS / Linux:
66

@@ -23,7 +23,7 @@ If you add ``source `which virtualenvwrapper.sh` `` to your local bash file (``~
2323
python -m pip install --upgrade virtualenvwrapper-win
2424
```
2525

26-
### **Step 2**: Create a virtual environment:
26+
### Step 2: Create a virtual environment:
2727

2828
### macOS / Linux / Windows:
2929

‎mkdocs.yml

Lines changed: 67 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,95 @@
1+
# Project information
12
site_name: SeleniumBase
3+
site_url: https://seleniumbase.io/
4+
site_author: Michael Mintz
5+
site_description: >-
6+
Create browser tests for web and mobile user interfaces.
7+
Fully customizable automation that builds on top of Selenium.
8+
Uses Python and pytest to run tests and execute commands.
9+
# Repository information
10+
repo_name: seleniumbase/SeleniumBase
211
repo_url: https://github.com/seleniumbase/SeleniumBase/
312
edit_uri: ""
413
site_dir: "site"
514
docs_dir: "docs"
15+
# Copyright
16+
copyright: Copyright &copy; 2016 - 2020 Michael Mintz / SeleniumBase
17+
# Extensions
618
markdown_extensions:
7-
- codehilite
8-
- toc:
19+
- fontawesome_markdown
20+
- markdown.extensions.admonition
21+
- markdown.extensions.attr_list
22+
- markdown.extensions.codehilite:
23+
guess_lang: false
24+
- markdown.extensions.def_list
25+
- markdown.extensions.footnotes
26+
- markdown.extensions.meta
27+
- markdown.extensions.toc:
928
permalink: true
29+
# Configuration
1030
theme:
1131
name: material
1232
logo: https://seleniumbase.io/img/logo3a.png
1333
favicon: img/favicon.ico
34+
language: en
35+
features:
36+
- tabs
37+
# Plugins
1438
plugins:
1539
- search
40+
- minify:
41+
minify_html: true
1642
- mkdocs-simple-hooks:
1743
hooks:
1844
on_pre_build: docs.prepare:main
45+
# Customization
46+
extra:
47+
social:
48+
- icon: fontawesome/brands/github
49+
link: https://github.com/seleniumbase/SeleniumBase
50+
- icon: fontawesome/brands/gitter
51+
link: https://gitter.im/seleniumbase/SeleniumBase
52+
- icon: fontawesome/brands/twitter
53+
link: https://twitter.com/seleniumbase
54+
- icon: fontawesome/brands/facebook
55+
link: https://www.facebook.com/SeleniumBase
56+
- icon: fontawesome/brands/instagram
57+
link: https://instagram.com/seleniumbase
58+
# Page tree
1959
nav:
2060
- Home Page: README.md
2161
- Features: help_docs/features_list.md
2262
- CMD Options: help_docs/customizing_test_runs.md
63+
- Python Setup:
64+
- Install Python, pip, git: help_docs/install_python_pip_git.md
65+
- Virtualenv Instructions: help_docs/virtualenv_instructions.md
66+
- Installation:
67+
- Install SeleniumBase: help_docs/install.md
68+
- WebDriver Installation: help_docs/webdriver_installation.md
69+
- Verifying WebDriver: help_docs/verify_webdriver.md
70+
- How it Works: help_docs/how_it_works.md
2371
- Examples: examples/ReadMe.md
2472
- Translations: help_docs/translations.md
25-
- Reports: examples/example_logs/ReadMe.md
2673
- API Reference: help_docs/method_summary.md
2774
- Mobile Testing: help_docs/mobile_testing.md
2875
- Console Scripts: seleniumbase/console_scripts/ReadMe.md
2976
- Site Tours: examples/tour_examples/ReadMe.md
30-
- How it Works: help_docs/how_it_works.md
31-
- Install Python, pip, git: help_docs/install_python_pip_git.md
32-
- Virtualenv Instructions: help_docs/virtualenv_instructions.md
33-
- Install SeleniumBase: help_docs/install.md
34-
- WebDriver Installation: help_docs/webdriver_installation.md
35-
- Verifying WebDriver: help_docs/verify_webdriver.md
36-
- Recorder and Exporting: seleniumbase/utilities/selenium_ide/ReadMe.md
3777
- MasterQA: examples/master_qa/ReadMe.md
3878
- Visual Testing: examples/visual_testing/ReadMe.md
39-
- GitHub CI: integrations/github/workflows/ReadMe.md
40-
- Happy Customers: help_docs/happy_customers.md
41-
- MySQL installation: help_docs/mysql_installation.md
42-
- Safari Driver Tips: help_docs/using_safari_driver.md
43-
- Hidden Files on macOS: help_docs/hidden_files_info.md
44-
- Jenkins on Azure: integrations/azure/jenkins/ReadMe.md
45-
- Jenkins on Google Cloud: integrations/google_cloud/ReadMe.md
46-
- Katalon Integration: integrations/katalon/ReadMe.md
47-
- Common Decorators: seleniumbase/common/ReadMe.md
48-
- Selenium Grid: seleniumbase/utilities/selenium_grid/ReadMe.md
49-
- Docker Help: integrations/docker/ReadMe.md
50-
- Master QA: seleniumbase/masterqa/ReadMe.md
51-
- Help Docs: help_docs/ReadMe.md
79+
- Integrations:
80+
- Logging and Reports: examples/example_logs/ReadMe.md
81+
- GitHub CI: integrations/github/workflows/ReadMe.md
82+
- Selenium Grid: seleniumbase/utilities/selenium_grid/ReadMe.md
83+
- Katalon Integration: integrations/katalon/ReadMe.md
84+
- MySQL Help: help_docs/mysql_installation.md
85+
- Jenkins on Azure: integrations/azure/jenkins/ReadMe.md
86+
- Jenkins on Google Cloud: integrations/google_cloud/ReadMe.md
87+
- Docker Help: integrations/docker/ReadMe.md
88+
- Recorder and Exporting: seleniumbase/utilities/selenium_ide/ReadMe.md
89+
- Master QA: seleniumbase/masterqa/ReadMe.md
90+
- Extra Help:
91+
- Table of Contents: help_docs/ReadMe.md
92+
- Decorators & Security: seleniumbase/common/ReadMe.md
93+
- Using Safari Driver: help_docs/using_safari_driver.md
94+
- macOS Hidden Files: help_docs/hidden_files_info.md
95+
- Happy Customers: help_docs/happy_customers.md

‎seleniumbase/common/ReadMe.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Using methods from the "common" folder.
1+
## Using [seleniumbase/common](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/common) methods.
22

33
### Part 1: Decorators - (from [decorators.py](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/common/decorators.py))
44

0 commit comments

Comments
 (0)