SeleniumHQ / selenium

A browser automation framework and ecosystem.
https://selenium.dev
Apache License 2.0
29.73k stars 8.02k forks source link

[πŸ› Bug]: PY - API Documentation: Default theme using newest Sphinx/Jinja has some visual issues #14180

Open emanlove opened 6 days ago

emanlove commented 6 days ago

What happened?

Some recent improvements have been made to the generation of the Python API documentation. There are a couple visual/display issues though seen with this change. Although this current implementation is a strong improvement these minor issues should be fixed. Leaving them here as a reminder.

The default theme aligns table to auto by default. There seems to be some previous discussion about this and some resolution. But still our Python docs are misaligned. What it should look like is if one removes the "align-default" class from the table within the css.

The second seen issue is that left sidebar index for some pages, like selenium.common.exceptions over extends past the sidebar. [Noting this can currently only seen under the development branch - instructions below. This link only shows the page it will appear in].

How can we reproduce the issue?

One can regenerate the docs using these instructions (without having to go through a full basel build)

virtualenv test-py38-env
source test-py38-env/bin/activate
pip install tox
git clone git@github.com:emanlove/selenium.git
cd se-api-docs-test/
git switch -c py-api-doc-13910 origin/py-api-doc-13910
tox -c py/tox.ini

The generated pages can be found under selenium/build/docs/api/py.

Relevant log output

N/A

Operating System

Seen on Windows but expect on all.

Selenium version

N/A

What are the browser(s) and version(s) where you see this issue?

Using Chrome

What are the browser driver(s) and version(s) where you see this issue?

N/A

Are you using Selenium Grid?

N/A

github-actions[bot] commented 6 days ago

@emanlove, thank you for creating this issue. We will troubleshoot it as soon as we can.


Info for maintainers

Triage this issue by using labels.

If information is missing, add a helpful comment and then I-issue-template label.

If the issue is a question, add the I-question label.

If the issue is valid but there is no time to troubleshoot it, consider adding the help wanted label.

If the issue requires changes or fixes from an external project (e.g., ChromeDriver, GeckoDriver, MSEdgeDriver, W3C), add the applicable G-* label, and it will provide the correct link and auto-close the issue.

After troubleshooting the issue, please add the R-awaiting answer label.

Thank you!