doc: fix API index
PATCH 1/1 doc: fix API index
With Doxygen 1.8.18, a warning appears when tagging
the main markdown header with {#index}.
That's why the tag has been removed from the API index in DPDK 20.05. Unfortunately it makes the index page classified as a standard "related page" instead of being the "main page".
The tag {#mainpage} could be used instead of {#index}. Another solution, chosen here, is to specify the main page file in the Doxygen configuration with the variable USE_MDFILE_AS_MAINPAGE.
--- doc/api/doxy-api.conf.in | 1 + 1 file changed, 1 insertion(+)
doc/api/doxy-api.conf.in +1 -0
@@ -3,6 +3,7 @@ PROJECT_NAME = DPDK PROJECT_NUMBER = @VERSION@ +USE_MDFILE_AS_MAINPAGE = @TOPDIR@/doc/api/doxy-api-index.md INPUT = @TOPDIR@/doc/api/doxy-api-index.md \ @TOPDIR@/drivers/bus/vdev \ @TOPDIR@/drivers/crypto/scheduler \
Signature · 1 line
2.26.2
Quoted 7 lines · Thomas Monjalon
With Doxygen 1.8.18, a warning appears when tagging
the main markdown header with {#index}.
That's why the tag has been removed from the API index in DPDK 20.05. Unfortunately it makes the index page classified as a standard "related page" instead of being the "main page".
Quoted 8 lines
The tag {#mainpage} could be used instead of {#index}. Another solution, chosen here, is to specify the main page file in the Doxygen configuration with the variable
USE_MDFILE_AS_MAINPAGE.Fixes 76fb8fc486f9 ("doc: fix build with doxygen 1.8.18")Signed-off-by Thomas Monjalon <[email protected]>
I don't have a system with 1.8.18.
With 1.8.15 (fc31), api/index.html is again populated with this page and links to this page are restored.
Signature · 1 line
David Marchand
David Marchand
AppliedQuoted 10 lines · David Marchand
Quoted 10 lines
With Doxygen 1.8.18, a warning appears when tagging
the main markdown header with {#index}.
That's why the tag has been removed from the API index in DPDK 20.05. Unfortunately it makes the index page classified as a standard "related page" instead of being the "main page".The tag {#mainpage} could be used instead of {#index}. Another solution, chosen here, is to specify the main page file in the Doxygen configuration with the variable
USE_MDFILE_AS_MAINPAGE.
Quoted 5 lines
Quoted 4 lines
Fixes 76fb8fc486f9 ("doc: fix build with doxygen 1.8.18")Signed-off-by Thomas Monjalon <[email protected]>Tested-by David Marchand <[email protected]>
Applied, thanks.
Luca, I saw you marked 76fb8fc486f9 ("doc: fix build with doxygen 1.8.18") for 19.11.3.
So this current patch is a candidate for 19.11.3 too.
Signature · 1 line
David Marchand
Quoted 15 lines · David Marchand
Quoted 13 lines · David Marchand
Quoted 13 lines
With Doxygen 1.8.18, a warning appears when tagging
the main markdown header with {#index}.
That's why the tag has been removed from the API index in DPDK 20.05. Unfortunately it makes the index page classified as a standard "related page" instead of being the "main page".The tag {#mainpage} could be used instead of {#index}. Another solution, chosen here, is to specify the main page file in the Doxygen configuration with the variable
USE_MDFILE_AS_MAINPAGE.Fixes 76fb8fc486f9 ("doc: fix build with doxygen 1.8.18")
Quoted 8 lines
Quoted 2 lines
Quoted 1 line
Signed-off-by Thomas Monjalon <[email protected]>Tested-by David Marchand <[email protected]>Applied, thanks.
Luca, I saw you marked
76fb8fc486f9("doc: fix build with doxygen 1.8.18") for 19.11.3.
So this current patch is a candidate for 19.11.3 too.
Already applied on suggestion from Thomas, thanks
Signature · 2 lines
Kind regards, Luca Boccassi