Skip to content

Commit

Permalink
[py] Adding draft configuration for ReadTheDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
diemol committed Jun 8, 2023
1 parent cc3b395 commit 8ace4ec
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 6 deletions.
32 changes: 32 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"
# You can also specify other tool versions:
# nodejs: "19"
# rust: "1.64"
# golang: "1.19"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: py/docs/conf.py

# Optionally build your docs in additional formats such as PDF and ePub
# formats:
# - pdf
# - epub

# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- requirements: py/docs/requirements.txt
2 changes: 2 additions & 0 deletions py/docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Jinja2==3.0.3
Sphinx==1.8.2
8 changes: 4 additions & 4 deletions py/docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@

# General information about the project.
project = 'Selenium'
copyright = '2011, plightbo, simon.m.stewart, hbchai, jrhuggins, et al.'
copyright = '2009-2023 Software Freedom Conservancy'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -228,9 +228,9 @@

# Bibliographic Dublin Core info.
epub_title = 'Selenium'
epub_author = 'plightbo, simon.m.stewart, hbchai, jrhuggins, et al.'
epub_publisher = 'plightbo, simon.m.stewart, hbchai, jrhuggins, et al.'
epub_copyright = '2011, plightbo, simon.m.stewart, hbchai, jrhuggins, et al.'
epub_author = 'The Selenium Project'
epub_publisher = 'The Selenium Project'
epub_copyright = '2009-2023 Software Freedom Conservancy'

# The language of the text. It defaults to the language option
# or en if the language is not set.
Expand Down
4 changes: 2 additions & 2 deletions py/docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,13 +126,13 @@ Selenium Server (optional)

For normal WebDriver scripts (non-Remote), the Java server is not needed.

However, to use Selenium Webdriver Remote or the legacy Selenium API (Selenium-RC), you need to also run the Selenium server. The server requires a Java Runtime Environment (JRE).
However, to use Selenium Webdriver Remote , you need to also run the Selenium server. The server requires a Java Runtime Environment (JRE).

Download the server separately, from: https://www.selenium.dev/downloads/

Run the server from the command line::

java -jar selenium-server-4.6.0.jar
java -jar selenium-server-4.10.0.jar

Then run your Python client scripts.

Expand Down

0 comments on commit 8ace4ec

Please sign in to comment.