Skip to content

Commit f79b87e

Browse files
committed
Update Python docs
1 parent 4f25b5a commit f79b87e

File tree

1 file changed

+42
-21
lines changed

1 file changed

+42
-21
lines changed

py/docs/source/index.rst

Lines changed: 42 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,41 @@ Python language bindings for Selenium WebDriver.
99

1010
The `selenium` package is used to automate web browser interaction from Python.
1111

12-
+-----------------+--------------------------------------------------------------------------------------+
13-
| **Home**: | https://selenium.dev |
14-
+-----------------+--------------------------------------------------------------------------------------+
15-
| **GitHub**: | https://github.com/SeleniumHQ/Selenium |
16-
+-----------------+--------------------------------------------------------------------------------------+
17-
| **PyPI**: | https://pypi.org/project/selenium |
18-
+-----------------+--------------------------------------------------------------------------------------+
19-
| **API Docs**: | `api.html <api.html>`_ |
20-
+-----------------+--------------------------------------------------------------------------------------+
21-
| **IRC/Slack**: | `Selenium chat room <https://www.selenium.dev/support/#ChatRoom>`_ |
22-
+-----------------+--------------------------------------------------------------------------------------+
23-
24-
Several browsers/drivers are supported (Firefox, Chrome, Edge, Safari), as well as the Remote protocol.
12+
+-------------------+------------------------------------------------+
13+
| **Home**: | https://selenium.dev |
14+
+-------------------+------------------------------------------------+
15+
| **GitHub**: | https://github.com/SeleniumHQ/Selenium |
16+
+-------------------+------------------------------------------------+
17+
| **PyPI**: | https://pypi.org/project/selenium |
18+
+-------------------+------------------------------------------------+
19+
| **IRC/Slack**: | https://www.selenium.dev/support/#ChatRoom |
20+
+-------------------+------------------------------------------------+
21+
| **Docs**: | https://www.selenium.dev/selenium/docs/api/py |
22+
+-------------------+------------------------------------------------+
23+
| **API Docs**: | `api.html <api.html>`_ |
24+
+-------------------+------------------------------------------------+
25+
26+
Updated documentation published with each commit is available at: https://selenium-python-api-docs.readthedocs.io
27+
28+
----
2529

2630
Supported Python Versions
2731
=========================
2832

2933
* Python 3.9+
3034

35+
Supported Browsers
36+
==================
37+
38+
Several browsers are supported, as well as the Remote protocol:
39+
40+
* Chrome
41+
* Edge
42+
* Firefox
43+
* Safari
44+
* WebKitGTK
45+
* WPEWebKit
46+
3147
Installing
3248
==========
3349

@@ -107,7 +123,8 @@ Example 1:
107123
Example 2:
108124
==========
109125

110-
Selenium WebDriver is often used as a basis for testing web applications. Here is a simple example using Python's standard `unittest <http://docs.python.org/3/library/unittest.html>`_ library:
126+
Selenium WebDriver is often used as a basis for testing web applications. Here is a simple example using Python's standard
127+
`unittest <http://docs.python.org/3/library/unittest.html>`_ library:
111128

112129
.. code-block:: python
113130
@@ -150,11 +167,15 @@ View source code online:
150167
Contributing
151168
=============
152169

170+
- Fork the selenium repo and clone it locally
153171
- Create a branch for your work
154-
- Ensure `tox` is installed (using a `virtualenv` is recommended)
155-
- Run: `python -m venv venv && source venv/bin/activate && pip install tox`
156-
- After making changes, before committing execute `tox -e linting`
157-
- If tox exits `0`, commit and push. Otherwise fix the newly introduced style violations.
158-
- `flake8` requires manual fixes
159-
- `black` will rewrite the violations automatically, however the files are unstaged and should staged again.
160-
- `isort` will rewrite the violations automatically, however the files are unstaged and should staged again.
172+
- `git checkout -b my-cool-branch-name`
173+
- Create a virtual environment and install tox
174+
- `python -m venv venv && source venv/bin/activate && pip install tox`
175+
- Make your changes
176+
- Run `tox -e linting`
177+
- If tox exits `0`, commit and push. Otherwise, fix the newly introduced style violations
178+
- `flake8` requires manual fixes
179+
- `black` will rewrite the violations automatically, however the files are unstaged and should staged again
180+
- `isort` will rewrite the violations automatically, however the files are unstaged and should staged again
181+
- Submit a Pull Request

0 commit comments

Comments
 (0)