kaxil opened a new pull request, #75478:
URL: https://github.com/apache/airflow/pull/75478

   Eight docs pages had a second (or third) section underlined like the page 
title. RST reads those as extra top-level titles, and Sphinx lists each one in 
the sidebar as if it were its own page. In How-to Guides, for example, 
"Configuring local settings", "Using Notifiers", "Support for Airflow 2 
plugins" and "Adding Dashboard Alert Messages" appear as separate pages. This 
is the same problem #75468 fixed for the upgrade guide, and 
sphinx-airflow-theme 0.3.15 (#75471) cannot hide it: its pages-only sidebar 
still shows every top-level title of a page.
   
   Each extra title moves down one level, and every heading under it moves down 
one level too, so the structure inside each section is unchanged. Only 
underline characters change, so existing `:ref:` labels and anchors keep 
working.
   
   | Page | Titles that showed as separate pages |
   |---|---|
   | `howto/set-config.rst` | Configuring local settings |
   | `howto/notifications.rst` | Using Notifiers |
   | `howto/custom-view-plugin.rst` | Developing React Applications with the 
Bootstrap Tool; Support for Airflow 2 plugins |
   | `howto/customize-ui.rst` | Adding Dashboard Alert Messages |
   | `howto/create-custom-decorator.rst` | (Optional) Adding IDE 
auto-completion support |
   | `core-concepts/debug.rst` | Debugging Airflow Dags on the command line |
   | `administration-and-deployment/dagfile-processing.rst` | Fine-tuning your 
Dag processor performance |
   | `administration-and-deployment/logging-monitoring/metrics.rst` | Metric 
Descriptions |
   
   **Why `metrics_registry.py` changes.** `metrics.rst` includes 
`metric_tables.rst`, which is generated at build time, and an included file 
shares the parent page's heading levels. Its "Counters", "Gauges" and "Timers" 
headings used `-`, the level "Metric Descriptions" now takes, so they would 
have become its siblings. The generator now writes them with `^`, which keeps 
them nested under "Metric Descriptions".
   
   I found the pages by parsing every `.rst` under `airflow-core/docs` with 
docutils and counting top-level sections. `index.rst` still has several, which 
is fine: it is the root page, so its sections never appear as sidebar entries.
   


-- 
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]

Reply via email to