diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 5528281b0f7..33866237518 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -116,7 +116,7 @@ add_custom_target( ${PYTHON_EXECUTABLE} ${GEN_DEVICETREE_REST_SCRIPT} --vendor-prefixes ${ZEPHYR_BASE}/dts/bindings/vendor-prefixes.txt ${DTS_ARGS} - ${DOCS_SRC_DIR}/reference/devicetree + ${DOCS_SRC_DIR}/build/dts/api VERBATIM USES_TERMINAL COMMENT "Generating Devicetree bindings documentation..." diff --git a/doc/guides/dts/api-usage.rst b/doc/build/dts/api-usage.rst similarity index 100% rename from doc/guides/dts/api-usage.rst rename to doc/build/dts/api-usage.rst diff --git a/doc/reference/devicetree/api.rst b/doc/build/dts/api/api.rst similarity index 100% rename from doc/reference/devicetree/api.rst rename to doc/build/dts/api/api.rst diff --git a/doc/reference/devicetree/index.rst b/doc/build/dts/api/index.rst similarity index 94% rename from doc/reference/devicetree/index.rst rename to doc/build/dts/api/index.rst index 7b41508cb05..e026aa226c7 100644 --- a/doc/reference/devicetree/index.rst +++ b/doc/build/dts/api/index.rst @@ -1,7 +1,7 @@ .. _devicetree: -Devicetree -########## +Reference +######### This is reference documentation for devicetree as it is used for Zephyr development. For a high-level guide, see :ref:`dt-guide`. For a diff --git a/doc/guides/dts/bindings.rst b/doc/build/dts/bindings.rst similarity index 100% rename from doc/guides/dts/bindings.rst rename to doc/build/dts/bindings.rst diff --git a/doc/guides/dts/design.rst b/doc/build/dts/design.rst similarity index 100% rename from doc/guides/dts/design.rst rename to doc/build/dts/design.rst diff --git a/doc/guides/dts/dt-vs-kconfig.rst b/doc/build/dts/dt-vs-kconfig.rst similarity index 100% rename from doc/guides/dts/dt-vs-kconfig.rst rename to doc/build/dts/dt-vs-kconfig.rst diff --git a/doc/guides/dts/howtos.rst b/doc/build/dts/howtos.rst similarity index 100% rename from doc/guides/dts/howtos.rst rename to doc/build/dts/howtos.rst diff --git a/doc/guides/dts/index.rst b/doc/build/dts/index.rst similarity index 88% rename from doc/guides/dts/index.rst rename to doc/build/dts/index.rst index ca6c748738e..948cbbbe9ad 100644 --- a/doc/guides/dts/index.rst +++ b/doc/build/dts/index.rst @@ -1,7 +1,7 @@ .. _dt-guide: -Devicetree Guide -################ +Devicetree +########## This is a high-level guide to devicetree as it is used for Zephyr development. See :ref:`devicetree` for reference material. @@ -16,3 +16,4 @@ See :ref:`devicetree` for reference material. howtos.rst troubleshooting.rst dt-vs-kconfig.rst + api/index.rst diff --git a/doc/guides/dts/intro.rst b/doc/build/dts/intro.rst similarity index 100% rename from doc/guides/dts/intro.rst rename to doc/build/dts/intro.rst diff --git a/doc/guides/dts/macros.bnf b/doc/build/dts/macros.bnf similarity index 100% rename from doc/guides/dts/macros.bnf rename to doc/build/dts/macros.bnf diff --git a/doc/guides/dts/main-example.dts b/doc/build/dts/main-example.dts similarity index 100% rename from doc/guides/dts/main-example.dts rename to doc/build/dts/main-example.dts diff --git a/doc/guides/dts/troubleshooting.rst b/doc/build/dts/troubleshooting.rst similarity index 100% rename from doc/guides/dts/troubleshooting.rst rename to doc/build/dts/troubleshooting.rst diff --git a/doc/guides/dts/zephyr_dt_build_flow.png b/doc/build/dts/zephyr_dt_build_flow.png similarity index 100% rename from doc/guides/dts/zephyr_dt_build_flow.png rename to doc/build/dts/zephyr_dt_build_flow.png diff --git a/doc/guides/dts/zephyr_dt_build_flow.svg b/doc/build/dts/zephyr_dt_build_flow.svg similarity index 100% rename from doc/guides/dts/zephyr_dt_build_flow.svg rename to doc/build/dts/zephyr_dt_build_flow.svg diff --git a/doc/guides/dts/zephyr_dt_i2c_example.png b/doc/build/dts/zephyr_dt_i2c_example.png similarity index 100% rename from doc/guides/dts/zephyr_dt_i2c_example.png rename to doc/build/dts/zephyr_dt_i2c_example.png diff --git a/doc/guides/dts/zephyr_dt_i2c_example.svg b/doc/build/dts/zephyr_dt_i2c_example.svg similarity index 100% rename from doc/guides/dts/zephyr_dt_i2c_example.svg rename to doc/build/dts/zephyr_dt_i2c_example.svg diff --git a/doc/guides/dts/zephyr_dt_i2c_high_level.png b/doc/build/dts/zephyr_dt_i2c_high_level.png similarity index 100% rename from doc/guides/dts/zephyr_dt_i2c_high_level.png rename to doc/build/dts/zephyr_dt_i2c_high_level.png diff --git a/doc/guides/dts/zephyr_dt_i2c_high_level.svg b/doc/build/dts/zephyr_dt_i2c_high_level.svg similarity index 100% rename from doc/guides/dts/zephyr_dt_i2c_high_level.svg rename to doc/build/dts/zephyr_dt_i2c_high_level.svg diff --git a/doc/guides/dts/zephyr_dt_inputs_outputs.svg b/doc/build/dts/zephyr_dt_inputs_outputs.svg similarity index 100% rename from doc/guides/dts/zephyr_dt_inputs_outputs.svg rename to doc/build/dts/zephyr_dt_inputs_outputs.svg diff --git a/doc/build/index.rst b/doc/build/index.rst index 5e3ba910eaa..11ac84ead96 100644 --- a/doc/build/index.rst +++ b/doc/build/index.rst @@ -9,4 +9,5 @@ Build and Configuration Systems cmake/index.rst + dts/index kconfig/index.rst diff --git a/doc/conf.py b/doc/conf.py index 101ea82a021..def23315bfc 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -152,7 +152,7 @@ html_context = { "reference_links": { "API": f"{reference_prefix}/doxygen/html/index.html", "Kconfig Options": f"{reference_prefix}/kconfig.html", - "Devicetree Bindings": f"{reference_prefix}/reference/devicetree/bindings.html", + "Devicetree Bindings": f"{reference_prefix}/build/dts/api/bindings.html", } } @@ -238,8 +238,8 @@ vcs_link_prefixes = { } vcs_link_exclude = [ "reference/kconfig.*", - "reference/devicetree/bindings.*", - "reference/devicetree/compatibles.*", + "build/dts/api/bindings.*", + "build/dts/api/compatibles.*", ] # -- Options for zephyr.kconfig ------------------------------------------- @@ -258,9 +258,9 @@ external_content_contents = [ ] external_content_keep = [ "reference/kconfig/*", - "reference/devicetree/bindings.rst", - "reference/devicetree/bindings/**/*", - "reference/devicetree/compatibles/**/*", + "build/dts/api/bindings.rst", + "build/dts/api/bindings/**/*", + "build/dts/api/compatibles/**/*", ] # -- Options for sphinx.ext.graphviz -------------------------------------- diff --git a/doc/guides/index.rst b/doc/guides/index.rst index f15392dfd96..4f5baff1ff5 100644 --- a/doc/guides/index.rst +++ b/doc/guides/index.rst @@ -12,7 +12,6 @@ User and Developer Guides code-relocation.rst flash_debug/index device_mgmt/index - dts/index env_vars.rst pinctrl/index emulator/index.rst diff --git a/doc/reference/index.rst b/doc/reference/index.rst index 6366dcec6d9..af37c5c954e 100644 --- a/doc/reference/index.rst +++ b/doc/reference/index.rst @@ -10,7 +10,6 @@ API Reference api/index.rst audio/index.rst canbus/index.rst - devicetree/index.rst display/index.rst edac/index.rst iterable_sections/index.rst