Skip to content

Commit e473514

Browse files
emanloveemanlove
committed
Regenerated project docs
1 parent 32088c5 commit e473514

File tree

1 file changed

+21
-136
lines changed

1 file changed

+21
-136
lines changed

‎docs/index.html

Lines changed: 21 additions & 136 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
33
<head>
44
<meta charset="utf-8" />
5-
<meta name="generator" content="Docutils 0.20.1: https://docutils.sourceforge.io/" />
5+
<meta name="generator" content="Docutils 0.21.2: https://docutils.sourceforge.io/" />
66
<meta name="viewport" content="width=device-width, initial-scale=1" />
77
<title>SeleniumLibrary</title>
88
<link rel="stylesheet" href="style.css" type="text/css" />
@@ -13,7 +13,7 @@
1313
<h1 class="title">SeleniumLibrary</h1>
1414

1515
<nav class="contents" id="contents" role="doc-toc">
16-
<p class="topic-title">Contents</p>
16+
<p class="topic-title"><a class="reference internal" href="#top">Contents</a></p>
1717
<ul class="simple">
1818
<li><p><a class="reference internal" href="#introduction" id="toc-entry-1">Introduction</a></p></li>
1919
<li><p><a class="reference internal" href="#keyword-documentation" id="toc-entry-2">Keyword Documentation</a></p></li>
@@ -22,26 +22,32 @@ <h1 class="title">SeleniumLibrary</h1>
2222
<li><p><a class="reference internal" href="#usage" id="toc-entry-5">Usage</a></p></li>
2323
<li><p><a class="reference internal" href="#extending-seleniumlibrary" id="toc-entry-6">Extending SeleniumLibrary</a></p></li>
2424
<li><p><a class="reference internal" href="#community" id="toc-entry-7">Community</a></p></li>
25-
<li><p><a class="reference internal" href="#versions" id="toc-entry-8">Versions</a></p></li>
26-
<li><p><a class="reference internal" href="#history" id="toc-entry-9">History</a></p></li>
2725
</ul>
2826
</nav>
2927
<section id="introduction">
3028
<h2><a class="toc-backref" href="#toc-entry-1" role="doc-backlink">Introduction</a></h2>
3129
<p><a class="reference external" href="https://github.com/robotframework/SeleniumLibrary">SeleniumLibrary</a> is a web testing library for <a class="reference external" href="https://robotframework.org">Robot Framework</a> that
3230
utilizes the <a class="reference external" href="https://www.seleniumhq.org/">Selenium</a> tool internally. The project is hosted on <a class="reference external" href="https://github.com/robotframework/SeleniumLibrary">GitHub</a>
3331
and downloads can be found from <a class="reference external" href="https://pypi.python.org/pypi/robotframework-seleniumlibrary">PyPI</a>.</p>
34-
<p>SeleniumLibrary works with Selenium 3 and 4. It supports Python 3.6 or
32+
<p>SeleniumLibrary currently works with Selenium 4. It supports Python 3.8 or
3533
newer. In addition to the normal <a class="reference external" href="https://python.org">Python</a> interpreter, it works also
3634
with <a class="reference external" href="https://pypy.org">PyPy</a>.</p>
37-
<p>SeleniumLibrary is based on the <a class="reference external" href="https://github.com/robotframework/OldSeleniumLibrary">old SeleniumLibrary</a> that was forked to
38-
<a class="reference external" href="https://github.com/robotframework/Selenium2Library">Selenium2Library</a> and then later renamed back to SeleniumLibrary.
39-
See the <a class="reference internal" href="#versions">Versions</a> and <a class="reference internal" href="#history">History</a> sections below for more information about
40-
different versions and the overall project history.</p>
41-
<a class="reference external image-reference" href="https://pypi.python.org/pypi/robotframework-seleniumlibrary"><img alt="https://img.shields.io/pypi/v/robotframework-seleniumlibrary.svg?label=version" src="https://img.shields.io/pypi/v/robotframework-seleniumlibrary.svg?label=version" /></a>
42-
<a class="reference external image-reference" href="https://pypi.python.org/pypi/robotframework-seleniumlibrary"><img alt="https://img.shields.io/pypi/dm/robotframework-seleniumlibrary.svg" src="https://img.shields.io/pypi/dm/robotframework-seleniumlibrary.svg" /></a>
43-
<a class="reference external image-reference" href="https://www.apache.org/licenses/LICENSE-2.0"><img alt="https://img.shields.io/pypi/l/robotframework-seleniumlibrary.svg" src="https://img.shields.io/pypi/l/robotframework-seleniumlibrary.svg" /></a>
44-
<a class="reference external image-reference" href="https://github.com/robotframework/SeleniumLibrary/actions/workflows/CI.yml"><img alt="https://github.com/robotframework/SeleniumLibrary/actions/workflows/CI.yml/badge.svg?branch=master" src="https://github.com/robotframework/SeleniumLibrary/actions/workflows/CI.yml/badge.svg?branch=master" /></a>
35+
<p>SeleniumLibrary is based on the &quot;old SeleniumLibrary&quot; that was forked to
36+
Selenium2Library and then later renamed back to SeleniumLibrary.
37+
See the <a class="reference external" href="https://github.com/robotframework/SeleniumLibrary/blob/master/VERSIONS.rst">VERSIONS.rst</a> for more information about different versions and the
38+
overall project history.</p>
39+
<a class="reference external image-reference" href="https://pypi.python.org/pypi/robotframework-seleniumlibrary">
40+
<img alt="https://img.shields.io/pypi/v/robotframework-seleniumlibrary.svg?label=version" src="https://img.shields.io/pypi/v/robotframework-seleniumlibrary.svg?label=version" />
41+
</a>
42+
<a class="reference external image-reference" href="https://pypi.python.org/pypi/robotframework-seleniumlibrary">
43+
<img alt="https://img.shields.io/pypi/dm/robotframework-seleniumlibrary.svg" src="https://img.shields.io/pypi/dm/robotframework-seleniumlibrary.svg" />
44+
</a>
45+
<a class="reference external image-reference" href="https://www.apache.org/licenses/LICENSE-2.0">
46+
<img alt="https://img.shields.io/pypi/l/robotframework-seleniumlibrary.svg" src="https://img.shields.io/pypi/l/robotframework-seleniumlibrary.svg" />
47+
</a>
48+
<a class="reference external image-reference" href="https://github.com/robotframework/SeleniumLibrary/actions/workflows/CI.yml">
49+
<img alt="https://github.com/robotframework/SeleniumLibrary/actions/workflows/CI.yml/badge.svg?branch=master" src="https://github.com/robotframework/SeleniumLibrary/actions/workflows/CI.yml/badge.svg?branch=master" />
50+
</a>
4551
</section>
4652
<section id="keyword-documentation">
4753
<h2><a class="toc-backref" href="#toc-entry-2" role="doc-backlink">Keyword Documentation</a></h2>
@@ -56,18 +62,8 @@ <h2><a class="toc-backref" href="#toc-entry-3" role="doc-backlink">Installation<
5662
versions, but you still need to install <a class="reference internal" href="#browser-drivers">browser drivers</a> separately.
5763
The <span class="docutils literal"><span class="pre">--upgrade</span></span> option can be omitted when installing the library for the
5864
first time.</p>
59-
<p>Those migrating from <a class="reference external" href="https://github.com/robotframework/Selenium2Library">Selenium2Library</a> can install SeleniumLibrary so that
60-
it is exposed also as Selenium2Library:</p>
61-
<pre class="literal-block">pip install --upgrade robotframework-selenium2library</pre>
62-
<p>The above command installs the normal SeleniumLibrary as well as a new
63-
Selenium2Library version that is just a thin wrapper to SeleniumLibrary.
64-
That allows importing Selenium2Library in tests while migrating to
65-
SeleniumLibrary.</p>
66-
<p>To install the last legacy <a class="reference external" href="https://github.com/robotframework/Selenium2Library">Selenium2Library</a> version, use this command instead:</p>
67-
<pre class="literal-block">pip install robotframework-selenium2library==1.8.0</pre>
68-
<p>With recent versions of <span class="docutils literal">pip</span> it is possible to install directly from the
69-
<a class="reference external" href="https://github.com/robotframework/SeleniumLibrary">GitHub</a> repository. To install latest source from the master branch, use
70-
this command:</p>
65+
<p>It is possible to install directly from the <a class="reference external" href="https://github.com/robotframework/SeleniumLibrary">GitHub</a> repository. To install
66+
latest source from the master branch, use this command:</p>
7167
<pre class="literal-block">pip install git+https://github.com/robotframework/SeleniumLibrary.git</pre>
7268
<p>Please note that installation will take some time, because <span class="docutils literal">pip</span> will
7369
clone the <a class="reference external" href="https://github.com/robotframework/SeleniumLibrary">SeleniumLibrary</a> project to a temporary directory and then
@@ -175,7 +171,6 @@ <h2><a class="toc-backref" href="#toc-entry-7" role="doc-backlink">Community</a>
175171
<p>If the provided documentation is not enough, there are various community channels
176172
available:</p>
177173
<ul class="simple">
178-
<li><p><a class="reference external" href="https://groups.google.com/group/robotframework-users">robotframework-users</a> mailing list</p></li>
179174
<li><p><span class="docutils literal">#seleniumlibrary</span> and <span class="docutils literal"><span class="pre">#seleniumlibrary-dev</span></span> channels in
180175
Robot Framework <a class="reference external" href="https://robotframework-slack-invite.herokuapp.com">Slack community</a></p></li>
181176
<li><p><a class="reference external" href="https://forum.robotframework.org/">Robot Framework forum</a> has channel for SeleniumLibrary.</p></li>
@@ -184,116 +179,6 @@ <h2><a class="toc-backref" href="#toc-entry-7" role="doc-backlink">Community</a>
184179
<li><p><a class="reference external" href="https://robotframework.org/#community">Other community channels</a> including paid support</p></li>
185180
</ul>
186181
</section>
187-
<section id="versions">
188-
<h2><a class="toc-backref" href="#toc-entry-8" role="doc-backlink">Versions</a></h2>
189-
<p>SeleniumLibrary has over the years lived under SeleniumLibrary and
190-
Selenium2Library names and different library versions have supported
191-
different Selenium and Python versions. This is summarized in the table
192-
below and the <a class="reference internal" href="#history">History</a> section afterwards explains the project history
193-
a bit more.</p>
194-
<table>
195-
<thead>
196-
<tr><th class="head"><p>Project</p></th>
197-
<th class="head"><p>Selenium Version</p></th>
198-
<th class="head"><p>Python Version</p></th>
199-
<th class="head"><p>Comment</p></th>
200-
</tr>
201-
</thead>
202-
<tbody>
203-
<tr><td><p>SeleniumLibrary 2.9.2 and earlier</p></td>
204-
<td><p>Selenium 1 and 2</p></td>
205-
<td><p>Python 2.5-2.7</p></td>
206-
<td><p>The original SeleniumLibrary using Selenium RC API.</p></td>
207-
</tr>
208-
<tr><td><p>Selenium2Library 1.8.0 and earlier</p></td>
209-
<td><p>Selenium 2 and 3</p></td>
210-
<td><p>Python 2.6-2.7</p></td>
211-
<td><p>Fork of SeleniumLibrary using Selenium WebDriver API.</p></td>
212-
</tr>
213-
<tr><td><p>SeleniumLibrary 3.0 and 3.1</p></td>
214-
<td><p>Selenium 2 and 3</p></td>
215-
<td><p>Python 2.7 and 3.3+</p></td>
216-
<td><p>Selenium2Library renamed and with Python 3 support and new architecture.</p></td>
217-
</tr>
218-
<tr><td><p>SeleniumLibrary 3.2</p></td>
219-
<td><p>Selenium 3</p></td>
220-
<td><p>Python 2.7 and 3.4+</p></td>
221-
<td><p>Drops Selenium 2 support.</p></td>
222-
</tr>
223-
<tr><td><p>SeleniumLibrary 4.0</p></td>
224-
<td><p>Selenium 3</p></td>
225-
<td><p>Python 2.7 and 3.4+</p></td>
226-
<td><p>Plugin API and support for event friging webdriver.</p></td>
227-
</tr>
228-
<tr><td><p>SeleniumLibrary 4.1</p></td>
229-
<td><p>Selenium 3</p></td>
230-
<td><p>Python 2.7 and 3.5+</p></td>
231-
<td><p>Drops Python 3.4 support.</p></td>
232-
</tr>
233-
<tr><td><p>SeleniumLibrary 4.2</p></td>
234-
<td><p>Selenium 3</p></td>
235-
<td><p>Python 2.7 and 3.5+</p></td>
236-
<td><p>Supports only Selenium 3.141.0 or newer.</p></td>
237-
</tr>
238-
<tr><td><p>SeleniumLibrary 4.4</p></td>
239-
<td><p>Selenium 3 and 4</p></td>
240-
<td><p>Python 2.7 and 3.6+</p></td>
241-
<td><p>New PythonLibCore and dropped Python 3.5 support.</p></td>
242-
</tr>
243-
<tr><td><p>SeleniumLibrary 5.0</p></td>
244-
<td><p>Selenium 3 and 4</p></td>
245-
<td><p>Python 3.6+</p></td>
246-
<td><p>Python 2 and Jython support is dropped.</p></td>
247-
</tr>
248-
<tr><td><p>SeleniumLibrary 5.1</p></td>
249-
<td><p>Selenium 3 and 4</p></td>
250-
<td><p>Python 3.6+</p></td>
251-
<td><p>Robot Framework 3.1 support is dropped.</p></td>
252-
</tr>
253-
<tr><td><p>Selenium2Library 3.0</p></td>
254-
<td><p>Depends on SeleniumLibrary</p></td>
255-
<td><p>Depends on SeleniumLibrary</p></td>
256-
<td><p>Thin wrapper for SeleniumLibrary 3.0 to ease transition.</p></td>
257-
</tr>
258-
</tbody>
259-
</table>
260-
</section>
261-
<section id="history">
262-
<h2><a class="toc-backref" href="#toc-entry-9" role="doc-backlink">History</a></h2>
263-
<p>SeleniumLibrary originally used the Selenium Remote Controller (RC) API.
264-
When Selenium 2 was introduced with the new but backwards incompatible
265-
WebDriver API, SeleniumLibrary kept using Selenium RC and separate
266-
Selenium2Library using WebDriver was forked. These projects contained
267-
mostly the same keywords and in most cases Selenium2Library was a drop-in
268-
replacement for SeleniumLibrary.</p>
269-
<p>Over the years development of the old SeleniumLibrary stopped and also
270-
the Selenium RC API it used was deprecated. Selenium2Library was developed
271-
further and replaced the old library as the de facto web testing library
272-
for Robot Framework.</p>
273-
<p>When Selenium 3 was released in 2016, it was otherwise backwards compatible
274-
with Selenium 2, but the deprecated Selenium RC API was removed. This had two
275-
important effects:</p>
276-
<ul class="simple">
277-
<li><p>The old SeleniumLibrary could not anymore be used with new Selenium versions.
278-
This project was pretty much dead.</p></li>
279-
<li><p>Selenium2Library was badly named as it supported Selenium 3 just fine.
280-
This project needed a new name.</p></li>
281-
</ul>
282-
<p>At the same time when Selenium 3 was released, Selenium2Library was going
283-
through larger architecture changes in order to ease future maintenance and
284-
to make adding Python 3 support easier. With all these big internal and
285-
external changes, it made sense to rename Selenium2Library back to
286-
SeleniumLibrary. This decision basically meant following changes:</p>
287-
<ul class="simple">
288-
<li><p>Create separate repository for the <a class="reference external" href="https://github.com/robotframework/OldSeleniumLibrary">old SeleniumLibrary</a> to preserve
289-
its history since Selenium2Library was forked.</p></li>
290-
<li><p>Rename Selenium2Library project and the library itself to <a class="reference external" href="https://github.com/robotframework/SeleniumLibrary">SeleniumLibrary</a>.</p></li>
291-
<li><p>Add new <a class="reference external" href="https://github.com/robotframework/Selenium2Library">Selenium2Library</a> project to ease transitioning from Selenium2Library
292-
to SeleniumLibrary.</p></li>
293-
</ul>
294-
<p>Going forward, all new development will happen in the new SeleniumLibrary
295-
project.</p>
296-
</section>
297182
</main>
298183
</body>
299184
</html>

0 commit comments

Comments
 (0)