Skip to content

Commit 9fb0cb5

Browse files
aaltatpekkaklarck
aaltat
authored and
pekkaklarck
committed
Added keyword documentation in own heading
1 parent 1039c8c commit 9fb0cb5

File tree

2 files changed

+27
-18
lines changed

2 files changed

+27
-18
lines changed

‎README.rst‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ Introduction
88

99
SeleniumLibrary_ is a web testing library for `Robot Framework`_ that
1010
utilizes the Selenium_ tool internally. The project is hosted on GitHub_
11-
and downloads can be found from PyPI_. See `keyword documentation`_
12-
for available keywords and more information about the library in general.
11+
and downloads can be found from PyPI_.
1312

1413
SeleniumLibrary works with Selenium 2.53.6 or newer, including Selenium 3.
1514
It supports Python 2.7 as well as Python 3.3 or newer. In addition to the
@@ -34,6 +33,11 @@ SeleniumLibrary 3.0 release is planned for October.
3433
.. image:: https://api.travis-ci.org/robotframework/SeleniumLibrary.png
3534
:target: http://travis-ci.org/robotframework/SeleniumLibrary
3635

36+
Keyword documentation
37+
---------------------
38+
See `keyword documentation`_ for available keywords and more information
39+
about the library in general.
40+
3741
Installation
3842
------------
3943

‎docs/index.html‎

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@ <h1 class="title">SeleniumLibrary</h1>
1414
<div class="contents topic" id="contents">
1515
<p class="topic-title first">Contents</p>
1616
<ul class="simple">
17-
<li><p><a class="reference internal" href="#introduction" id="id4">Introduction</a></p></li>
18-
<li><p><a class="reference internal" href="#installation" id="id5">Installation</a></p></li>
19-
<li><p><a class="reference internal" href="#browser-drivers" id="id6">Browser drivers</a></p></li>
20-
<li><p><a class="reference internal" href="#usage" id="id7">Usage</a></p></li>
21-
<li><p><a class="reference internal" href="#support" id="id8">Support</a></p></li>
22-
<li><p><a class="reference internal" href="#versions" id="id9">Versions</a></p></li>
23-
<li><p><a class="reference internal" href="#history" id="id10">History</a></p></li>
17+
<li><p><a class="reference internal" href="#introduction" id="id5">Introduction</a></p></li>
18+
<li><p><a class="reference internal" href="#keyword-documentation" id="id6">Keyword documentation</a></p></li>
19+
<li><p><a class="reference internal" href="#installation" id="id7">Installation</a></p></li>
20+
<li><p><a class="reference internal" href="#browser-drivers" id="id8">Browser drivers</a></p></li>
21+
<li><p><a class="reference internal" href="#usage" id="id9">Usage</a></p></li>
22+
<li><p><a class="reference internal" href="#support" id="id10">Support</a></p></li>
23+
<li><p><a class="reference internal" href="#versions" id="id11">Versions</a></p></li>
24+
<li><p><a class="reference internal" href="#history" id="id12">History</a></p></li>
2425
</ul>
2526
</div>
2627
<div class="section" id="introduction">
27-
<h1><a class="toc-backref" href="#id4">Introduction</a></h1>
28+
<h1><a class="toc-backref" href="#id5">Introduction</a></h1>
2829
<p><a class="reference external" href="https://github.com/robotframework/SeleniumLibrary">SeleniumLibrary</a> is a web testing library for <a class="reference external" href="http://robotframework.org">Robot Framework</a> that
2930
utilizes the <a class="reference external" href="http://seleniumhq.org">Selenium</a> tool internally. The project is hosted on <a class="reference external" href="https://github.com/robotframework/SeleniumLibrary">GitHub</a>
30-
and downloads can be found from <a class="reference external" href="https://pypi.python.org/pypi/robotframework-seleniumlibrary">PyPI</a>. See <a class="reference external" href="http://robotframework.org/SeleniumLibrary/SeleniumLibrary.html">keyword documentation</a>
31-
for available keywords and more information about the library in general.</p>
31+
and downloads can be found from <a class="reference external" href="https://pypi.python.org/pypi/robotframework-seleniumlibrary">PyPI</a>.</p>
3232
<p>SeleniumLibrary works with Selenium 2.53.6 or newer, including Selenium 3.
3333
It supports Python 2.7 as well as Python 3.3 or newer. In addition to the
3434
normal <a class="reference external" href="http://python.org">Python</a> interpreter, it works also with <a class="reference external" href="http://pypy.org">PyPy</a> and <a class="reference external" href="http://jython.org">Jython</a>. Unfortunately
@@ -44,8 +44,13 @@ <h1><a class="toc-backref" href="#id4">Introduction</a></h1>
4444
<a class="reference external image-reference" href="http://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>
4545
<a class="reference external image-reference" href="http://travis-ci.org/robotframework/SeleniumLibrary"><img alt="https://api.travis-ci.org/robotframework/SeleniumLibrary.png" src="https://api.travis-ci.org/robotframework/SeleniumLibrary.png" /></a>
4646
</div>
47+
<div class="section" id="keyword-documentation">
48+
<h1><a class="toc-backref" href="#id6">Keyword documentation</a></h1>
49+
<p>See <a class="reference external" href="http://robotframework.org/SeleniumLibrary/SeleniumLibrary.html">keyword documentation</a> for available keywords and more information
50+
about the library in general.</p>
51+
</div>
4752
<div class="section" id="installation">
48-
<h1><a class="toc-backref" href="#id5">Installation</a></h1>
53+
<h1><a class="toc-backref" href="#id7">Installation</a></h1>
4954
<p>The recommended installation method is using <a class="reference external" href="http://pip-installer.org">pip</a>:</p>
5055
<pre class="literal-block">pip install --pre --upgrade robotframework-seleniumlibrary</pre>
5156
<p>Running this command installs also the latest Selenium and Robot Framework
@@ -73,7 +78,7 @@ <h1><a class="toc-backref" href="#id5">Installation</a></h1>
7378
using <span class="docutils literal">pip</span> see <a class="reference external" href="http://pip-installer.org">its own documentation</a>.</p>
7479
</div>
7580
<div class="section" id="browser-drivers">
76-
<h1><a class="toc-backref" href="#id6">Browser drivers</a></h1>
81+
<h1><a class="toc-backref" href="#id8">Browser drivers</a></h1>
7782
<p>After installing the library, you still need to install browser and
7883
operating system specific browser drivers for all those browsers you
7984
want to use in tests. These are the exact same drivers you need to use with
@@ -89,7 +94,7 @@ <h1><a class="toc-backref" href="#id6">Browser drivers</a></h1>
8994
to know when to update drivers you use.</p>
9095
</div>
9196
<div class="section" id="usage">
92-
<h1><a class="toc-backref" href="#id7">Usage</a></h1>
97+
<h1><a class="toc-backref" href="#id9">Usage</a></h1>
9398
<p>To use SeleniumLibrary in Robot Framework tests, the library needs to
9499
first be imported using the <span class="docutils literal">Library</span> setting as any other library.
95100
The library accepts some import time arguments, which are documented
@@ -146,7 +151,7 @@ <h1><a class="toc-backref" href="#id7">Usage</a></h1>
146151
general see the <a class="reference external" href="http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html">Robot Framework User Guide</a>.</p>
147152
</div>
148153
<div class="section" id="support">
149-
<h1><a class="toc-backref" href="#id8">Support</a></h1>
154+
<h1><a class="toc-backref" href="#id10">Support</a></h1>
150155
<p>If the provided documentation is not enough, there are various support forums
151156
available:</p>
152157
<ul class="simple">
@@ -159,7 +164,7 @@ <h1><a class="toc-backref" href="#id8">Support</a></h1>
159164
</ul>
160165
</div>
161166
<div class="section" id="versions">
162-
<h1><a class="toc-backref" href="#id9">Versions</a></h1>
167+
<h1><a class="toc-backref" href="#id11">Versions</a></h1>
163168
<p>SeleniumLibrary has over the years lived under SeleniumLibrary and
164169
Selenium2Library names and different library versions have supported
165170
different Selenium and Python versions. This is summarized in the table
@@ -204,7 +209,7 @@ <h1><a class="toc-backref" href="#id9">Versions</a></h1>
204209
</table>
205210
</div>
206211
<div class="section" id="history">
207-
<h1><a class="toc-backref" href="#id10">History</a></h1>
212+
<h1><a class="toc-backref" href="#id12">History</a></h1>
208213
<p>SeleniumLibrary originally used the Selenium Remote Controller (RC) API.
209214
When Selenium 2 was introduced with the new but backwards incompatible
210215
WebDriver API, SeleniumLibrary kept using Selenium RC and separate

0 commit comments

Comments
 (0)