-
-
Notifications
You must be signed in to change notification settings - Fork 8.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[py] Update Python documentation (modernization) #15459
Conversation
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨No code suggestions found for the PR. |
Note: I already fixed the issues in the PR Reviewers Guide above. |
This looks good but there are version incompatibilities. Can you look into that and we can get it merged |
@AutomatedTester I rolled back the Sphinx version to 7.4.7 and everything should work now.That's weird it couldn't find the latest version. |
I'm merging this to make it into the 4.30 release.. I think it should be good. |
* [py] Remove blank line in tox.ini * [py] Update instructions for docs * [py] Bump Sphinx and Jinja2 versions for building docs * [py] Change permissions of index.rst * [py] Update instructions for building docs * [py] Update Python documentation (modernization) * [py] fix typos in README * [py] Fix theme name * [py] Update browser names in README * [py] Add virtual env name * [py] Change Sphinx version for docs * [py] tiny fix in README
User description
Motivation and Context
This PR updates the Python API documentation. Previously, the docs looked pretty dated. They now use the "Material for Sphinx" theme, which is responsive (looks much better on mobile) and generally has a cleaner and more modern look.
Changes in this PR include:
default
tosphinx-material
: https://pypi.org/project/sphinx-materialpy/docs/README.rst
.py/docs/requirements.txt
sphinx-material
as a new requirement inpy/docs/requirements.txt
.py/docs/selenium_logo_small.png
as the logo for the docs.py/docs/README.rst
) with:I built and tested the docs locally with
tox -c py/tox.ini -e docs
.See screenshot in comments below.
Types of changes
Checklist
PR Type
Documentation, Enhancement
Description
Updated Python documentation with modernized theme and improved content.
Switched Sphinx theme to
sphinx-material
for better aesthetics.Enhanced documentation build instructions and examples for clarity.
Bumped Sphinx and Jinja2 versions and added
sphinx-material
dependency.Changes walkthrough 📝
conf.py
Updated Sphinx configuration for modernized documentation
py/docs/source/conf.py
sphinx_material
.README.rst
Enhanced README with updated build instructions
py/docs/README.rst
index.rst
Refined main documentation page with updated examples
py/docs/source/index.rst
details.
requirements.txt
Updated documentation dependencies
py/docs/requirements.txt
sphinx-material
as a new dependency.tox.ini
Adjusted tox configuration for documentation build
py/tox.ini