kaxil opened a new pull request, #1700:
URL: https://github.com/apache/airflow-site/pull/1700
The left sidebar on the Airflow docs is hard to scan. This fixes the two
causes.
**Wrapped titles read as separate entries.** Sidebar items were 16px with
`line-height: 1.63` and no space between items, so the gap between the two
lines of one title equals the gap between two titles. "Add tags to Dags and use
it / for filtering in the UI" reads as two links, and in the 270px sidebar 17
of the 38 How-to Guides entries wrap. Items are now 15px with `line-height:
1.4` and 4px padding, so the space between entries is visibly larger than the
space inside one. Nested levels get a faint guide line on the left.
**The sidebar mixes pages with the current page's headings.**
`globaltoc.html` called `toctree()` without `titles_only`, so Sphinx inserted
the open page's section headings among its child pages. On the Installation
page, "Local start for development and testing", "Using PyPI" and seven other
headings sit next to Prerequisites and Dependencies as if they were pages.
Those headings already appear in the right-hand "On this page" TOC, so the left
sidebar now lists pages only. This is a new `sidebar_titles_only` theme option
(default `true`, next to `sidebar_collapse` and `sidebar_includehidden`), so a
project that wants headings in the left sidebar can set `html_theme_options =
{"sidebar_titles_only": False}`.
A few entries such as "Configuring local settings" and "Support for Airflow
2 plugins" still show up as pages. Those `.rst` files have more than one
top-level title, the same problem apache/airflow#75468 fixed for the upgrade
guide, so the fix belongs in the Airflow repo.
Once released, `apache/airflow` needs its `sphinx-airflow-theme` pin in
`devel-common/pyproject.toml` bumped to pick this up.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
