diff --git a/.github/workflows/doc-build.yml b/.github/workflows/doc-build.yml index 42812ae5199..e0a73cca4b4 100644 --- a/.github/workflows/doc-build.yml +++ b/.github/workflows/doc-build.yml @@ -73,7 +73,7 @@ jobs: DOC_TAG="development" fi - DOC_TAG=${DOC_TAG} SPHINXOPTS="-q -W -j auto" make -C doc html + DOC_TAG=${DOC_TAG} SPHINXOPTS="-q -W -j auto -t publish" make -C doc html - name: compress-docs run: | diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html index 0db13972a1f..205b2488555 100644 --- a/doc/_templates/layout.html +++ b/doc/_templates/layout.html @@ -17,6 +17,18 @@ {% block menu %} {% include "zversions.html" %} {{ super() }} + {% if reference_links %} +
+

Reference

+ +
+ {% endif %} {% endblock %} {% block extrahead %} diff --git a/doc/conf.py b/doc/conf.py index 5694d134a38..5b674b2ea78 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -135,6 +135,9 @@ html_show_sphinx = False html_search_scorer = str(ZEPHYR_BASE / "doc" / "_static" / "js" / "scorer.js") is_release = tags.has("release") # pylint: disable=undefined-variable +reference_prefix = "" +if tags.has("publish"): # pylint: disable=undefined-variable + reference_prefix = f"/{version}" if is_release else "/latest" docs_title = "Docs / {}".format(version if is_release else "Latest") html_context = { "show_license": True, @@ -151,6 +154,11 @@ html_context = { ("1.14.1", "/1.14.1/"), ), "display_vcs_link": True, + "reference_links": { + "API": f"{reference_prefix}/doxygen/html/index.html", + "Kconfig Options": f"{reference_prefix}/reference/kconfig/index.html", + "Devicetree Bindings": f"{reference_prefix}/reference/devicetree/bindings.html", + } } # -- Options for LaTeX output --------------------------------------------- diff --git a/doc/index.rst b/doc/index.rst index 2046f607167..b43a7eab531 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -117,7 +117,6 @@ Sections Indices and Tables ****************** -* :ref:`configuration_options` * :ref:`glossary` * :ref:`genindex`