From 259db8c090e43673b56c6eb1ccfc8ac96761140a Mon Sep 17 00:00:00 2001 From: Gerard Marull-Paretas Date: Mon, 25 Oct 2021 17:05:17 +0200 Subject: [PATCH] doc: deactivate breathe extension Deactivate breathe extension from docs. Signed-off-by: Gerard Marull-Paretas --- doc/conf.py | 28 ---------------------------- doc/known-warnings.txt | 22 ---------------------- doc/requirements.txt | 1 - 3 files changed, 51 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index c9cd9699c28..709f3ea4680 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -73,7 +73,6 @@ with open(ZEPHYR_BASE / "SDK_VERSION") as f: # -- General configuration ------------------------------------------------ extensions = [ - "breathe", "sphinx_rtd_theme", "sphinx.ext.todo", "sphinx.ext.extlinks", @@ -249,33 +248,6 @@ doxyrunner_fmt = True doxyrunner_fmt_vars = {"ZEPHYR_BASE": str(ZEPHYR_BASE), "ZEPHYR_VERSION": version} doxyrunner_outdir_var = "DOXY_OUT" -# -- Options for Breathe plugin ------------------------------------------- - -breathe_projects = {"Zephyr": str(doxyrunner_outdir / "xml")} -breathe_default_project = "Zephyr" -breathe_domain_by_extension = { - "h": "c", - "c": "c", -} -breathe_show_enumvalue_initializer = True -breathe_default_members = ("members", ) - -cpp_id_attributes = [ - "__syscall", - "__syscall_always_inline", - "__deprecated", - "__may_alias", - "__used", - "__unused", - "__weak", - "__attribute_const__", - "__DEPRECATED_MACRO", - "FUNC_NORETURN", - "__subsystem", - "ALWAYS_INLINE", -] -c_id_attributes = cpp_id_attributes - # -- Options for html_redirect plugin ------------------------------------- html_redirect_pages = redirects.REDIRECTS diff --git a/doc/known-warnings.txt b/doc/known-warnings.txt index 35a0ed60b03..72ad03d55d5 100644 --- a/doc/known-warnings.txt +++ b/doc/known-warnings.txt @@ -1,24 +1,2 @@ # Each line should contain the regular expression of a known Sphinx warning # that should be filtered out - -# Function and (enum or struct) name -.*Duplicate C declaration.*\n.*'\.\. c:.*:: flash_img_check'.* -.*Duplicate C declaration.*\n.*'\.\. c:.*:: fs_statvfs'.* -.*Duplicate C declaration.*\n.*'\.\. c:.*:: .*dmic_trigger.*'.* -.*Duplicate C declaration.*\n.*'\.\. c:.*:: dma_config'.* -.*Duplicate C declaration.*\n.*'\.\. c:.*:: net_if_mcast_monitor'.* - -# Struct and typedef name -.*Duplicate C declaration.*\n.*'\.\. c:.*:: zsock_fd_set'.* - -# Function and extern function -.*Duplicate C declaration.*\n.*'\.\. c:.*:: .*net_if_ipv4_addr_mask_cmp.*'.* -.*Duplicate C declaration.*\n.*'\.\. c:.*:: .*net_if_ipv4_is_addr_bcast.*'.* -.*Duplicate C declaration.*\n.*'\.\. c:.*:: .*net_if_ipv4_addr_lookup.*'.* -.*Duplicate C declaration.*\n.*'\.\. c:.*:: .*net_if_ipv6_addr_lookup.*'.* -.*Duplicate C declaration.*\n.*'\.\. c:.*:: .*net_if_ipv6_maddr_lookup.*'.* - -# Common field names -.*Duplicate C declaration.*\n.*'\.\. c:.*:: .*struct in_addr.*'.* -.*Duplicate C declaration.*\n.*'\.\. c:.*:: .*struct in6_addr.*'.* -.*Duplicate C declaration.*\n.*'\.\. c:.*:: .*struct net_if.*'.* diff --git a/doc/requirements.txt b/doc/requirements.txt index 55cf8de6297..468be6969c1 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,6 +1,5 @@ # DOC: used to generate docs -breathe>=4.34 sphinx sphinx_rtd_theme~=2.0 sphinx-tabs