search

zephyrproject-rtos / zephyr

Primary Git Repository for the Zephyr Project. Zephyr is a new generation, scalable, optimized, secure RTOS for multiple hardware architectures.
https://docs.zephyrproject.org
Apache License 2.0
10.98k stars 6.69k forks source link

doc: Current section is not shown in the side pane nor the page top cookie #35522

Closed yashi closed 3 years ago

yashi commented 3 years ago

Describe the bug Pages about Device tree bindings doesn't show

To Reproduce Open one of many binding pages at https://docs.zephyrproject.org/latest/reference/devicetree/bindings.html

e.g) https://docs.zephyrproject.org/latest/reference/devicetree/bindings/cpu/arm%2Ccortex-m3.html#dtbinding-arm-cortex-m3

Expected behavior 1) side pane shows the current section. 2) top cookies show the current location.

Impact If you land on one of these pages, you don't know where you are. It doesn't hurt anyone but nice to have them shown.

gmarull commented 3 years ago

These are pages marked as :orphan:, so it is expected. Note that including all bindings/kconfig options in the toctree is not an option since it significantly increases documentation build time.

yashi commented 3 years ago

Thanks. I didn't know it was intentional. Closing.