Added config option needs_report_dead_links (#937)

Co-authored-by: Daniel Woste <daniel.woste@useblocks.com>
useblocks · Aug 4, 2023 · c73c44f · c73c44f
1 parent 8d4d06e
commit c73c44f
Show file tree

Hide file tree

Showing 13 changed files with 664 additions and 14 deletions.
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -27,6 +27,9 @@ Released: under development
 * Removed configuration **needs_ide_directive_snippets** to support custom directive snippets for IDE features.
 * Provided new IDE support option: VsCode extension
   `Sphinx-Needs-VsCode <https://marketplace.visualstudio.com/items?itemName=useblocks.sphinx-needs-vscode>`_.
+* Improvement: Added configuration option :ref:`needs_report_dead_links`, which can deactivate log messages of
+  outgoing dead links.
+  (`#920 <https://github.com/useblocks/sphinx-needs/issues/920>`_)
 * Improvement: Configuration option :ref:`needs_allow_unsafe_filters` added, which allows unsafe filter for
   :ref:`filter_func`.
   (`#831 <https://github.com/useblocks/sphinx-needs/issues/831>`_)

diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -289,6 +289,21 @@ In this cases, you can provide a list of tuples.
    If you need access to other needs for complex filtering, you can maybe provide your own :ref:`dynamic_functions`
    and perform the filtering there.
 
+.. _needs_report_dead_links:
+
+needs_report_dead_links
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Deactivate/activate log messages of outgoing dead links. If set to ``False``, then deactivate.
+
+Default value is ``True``.
+
+Configuration example:
+
+.. code-block:: python
+
+    needs_report_dead_links = False
+
 .. _needs_extra_links:
 
 needs_extra_links

diff --git a/sphinx_needs/needs.py b/sphinx_needs/needs.py
@@ -221,6 +221,9 @@ def setup(app: Sphinx) -> Dict[str, Any]:
     # Example: [{"name": "blocks, "incoming": "is blocked by", "copy_link": True, "color": "#ffcc00"}]
     app.add_config_value("needs_extra_links", [], "html")
 
+    # Deactivate log msgs of dead links if set to False, default is True
+    app.add_config_value("needs_report_dead_links", True, "html", types=[bool])
+
     app.add_config_value("needs_filter_data", {}, "html")
     app.add_config_value("needs_allow_unsafe_filters", False, "html")
 

diff --git a/sphinx_needs/roles/need_outgoing.py b/sphinx_needs/roles/need_outgoing.py
@@ -27,6 +27,8 @@ def process_need_outgoing(
         needs_all_needs = getattr(env, "needs_all_needs", {})
         ref_need = needs_all_needs[node_need_ref["reftarget"]]
 
+        report_dead_links = getattr(env.config, "needs_report_dead_links", True)
+
         # Let's check if NeedIncoming shall follow a specific link type
         if "link_type" in node_need_ref.attributes:
             links = ref_need[node_need_ref.attributes["link_type"]]
@@ -120,20 +122,21 @@ def process_need_outgoing(
                     dead_link_para.attributes["classes"].append("forbidden")
                     log_level = "WARNING"
 
-                if node_need_ref and node_need_ref.line:
-                    log.log(
-                        log_level,
-                        f"Needs: linked need {link} not found "
-                        f"(Line {node_need_ref.line} of file {node_need_ref.source})",
-                    )
-                else:
-                    log.log(
-                        log_level,
-                        "Needs: outgoing linked need {} not found (document: {}, "
-                        "source need {} on line {} )".format(
-                            link, ref_need["docname"], ref_need["id"], ref_need["lineno"]
-                        ),
-                    )
+                if report_dead_links:
+                    if node_need_ref and node_need_ref.line:
+                        log.log(
+                            log_level,
+                            f"Needs: linked need {link} not found "
+                            f"(Line {node_need_ref.line} of file {node_need_ref.source})",
+                        )
+                    else:
+                        log.log(
+                            log_level,
+                            "Needs: outgoing linked need {} not found (document: {}, "
+                            "source need {} on line {} )".format(
+                                link, ref_need["docname"], ref_need["id"], ref_need["lineno"]
+                            ),
+                        )
 
             # If we have several links, we add an empty text between them
             if (index + 1) < len(link_list):

diff --git a/tests/doc_test/doc_report_dead_links_false/Makefile b/tests/doc_test/doc_report_dead_links_false/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = needstestdocs
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/tests/doc_test/doc_report_dead_links_false/conf.py b/tests/doc_test/doc_report_dead_links_false/conf.py
@@ -0,0 +1,178 @@
+#
+# needs test docs documentation build configuration file, created by
+# sphinx-quickstart on Tue Mar 28 11:37:14 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../../sphinxcontrib"))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+
+extensions = ["sphinx_needs", "sphinxcontrib.plantuml"]
+
+needs_types = [
+    {"directive": "story", "title": "User Story", "prefix": "US_", "color": "#BFD8D2", "style": "node"},
+    {"directive": "spec", "title": "Specification", "prefix": "SP_", "color": "#FEDCD2", "style": "node"},
+    {"directive": "impl", "title": "Implementation", "prefix": "IM_", "color": "#DF744A", "style": "node"},
+    {"directive": "test", "title": "Test Case", "prefix": "TC_", "color": "#DCB239", "style": "node"},
+]
+
+needs_report_dead_links = False
+
+needs_extra_links = [
+    {
+        "option": "blocks",
+        "incoming": "is blocked by",
+        "outgoing": "blocks",
+        "copy": False,
+        "style": "bold,#AA0000",
+        "allow_dead_links": True,
+    },
+    {
+        "option": "tests",
+        "incoming": "is tested by",
+        "outgoing": "tests",
+        "copy": True,
+        "style": "dashed,#00AA00",
+        "style_part": "dotted,#00AA00",
+    },
+]
+
+plantuml = "java -jar %s" % os.path.join(os.path.dirname(__file__), "..", "utils", "plantuml.jar")
+plantuml_output_format = "svg"
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = ".rst"
+
+# The master toctree document.
+master_doc = "index"
+
+# General information about the project.
+project = "needs test docs"
+copyright = "2017, team useblocks"
+author = "team useblocks"
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = "1.0"
+# The full version, including alpha/beta/rc tags.
+release = "1.0"
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "en"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "alabaster"
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ["_static"]
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "needstestdocsdoc"
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, "needstestdocs.tex", "needs test docs Documentation", "team useblocks", "manual"),
+]
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [(master_doc, "needstestdocs", "needs test docs Documentation", [author], 1)]
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (
+        master_doc,
+        "needstestdocs",
+        "needs test docs Documentation",
+        author,
+        "needstestdocs",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
+]
diff --git a/tests/doc_test/doc_report_dead_links_false/index.rst b/tests/doc_test/doc_report_dead_links_false/index.rst
@@ -0,0 +1,47 @@
+EXTRA LINKS DOCUMENT
+====================
+
+Stories
+-------
+
+.. story:: My requirement
+   :id: REQ_001
+   :blocks: REQ_003, DEAD_LINK_ALLOWED
+
+.. story:: My requirement 2
+   :id: REQ_002
+
+.. story:: My requirement 3
+   :id: REQ_003
+
+.. story:: My requirement 4
+   :id: REQ_004
+   :links: ANOTHER_DEAD_LINK
+
+.. story:: Req 5
+   :id: REQ_005
+   :blocks: REQ_001
+
+   :need_part:`(1) awesome part`
+
+   :need_part:`(cool) a cool part`
+
+
+Tests
+-----
+
+.. test:: Test of requirements
+   :id: TEST_001
+   :tests: REQ_001, REQ_003
+
+.. test:: Test of requirements2
+   :id: TEST_002
+   :tests: REQ_001
+
+.. test:: Test of requirements 5
+   :id: TEST_003
+   :tests: REQ_005.1,REQ_005.cool
+
+.. test:: Test of invalid need_part links
+   :id: TEST_004
+   :tests: REQ_005.1,REQ_005.invalid
diff --git a/tests/doc_test/doc_report_dead_links_false/make.bat b/tests/doc_test/doc_report_dead_links_false/make.bat
@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+set SPHINXPROJ=needstestdocs
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd
diff --git a/tests/doc_test/doc_report_dead_links_true/Makefile b/tests/doc_test/doc_report_dead_links_true/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = needstestdocs
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)