Links in test-suite and co do not throw error

":links:" where not handled correctly, if not other
Sphinx-Need object was part of the same document.

Fixes #51

.pre-commit-config.yaml

@@ -4,7 +4,7 @@ repos:
     hooks:
       - id: black
 
-  - repo: https://gitlab.com/pycqa/flake8
+  - repo: https://github.com/pycqa/flake8
     rev: 4.0.1
     hooks:
       - id: flake8

docs/changelog.rst

@@ -5,6 +5,10 @@ Changelog
 -----
 :Released: under development
 
+* Bugfix: Links in `test-suite` and co. do not raise error.
+  `#51 <https://github.com/useblocks/sphinx-test-reports/issues/51>`_
+
+
 1.0.1
 -----
 :Released: 04.11.2022

sphinxcontrib/test_reports/directives/test_case.py

@@ -1,6 +1,7 @@
 from docutils import nodes
 from docutils.parsers.rst import directives
 from sphinx_needs.api import add_need
+from sphinx_needs.utils import add_doc
 
 from sphinxcontrib.test_reports.directives.test_common import TestCommonDirective
 from sphinxcontrib.test_reports.exceptions import TestReportInvalidOption
@@ -187,4 +188,6 @@ def run(self, nested=False, suite_count=-1, case_count=-1):
             time=time,
             style=style,
         )
+
+        add_doc(self.env, docname)
         return main_section

sphinxcontrib/test_reports/directives/test_file.py

@@ -3,6 +3,7 @@
 from docutils import nodes
 from docutils.parsers.rst import directives
 from sphinx_needs.api import add_need
+from sphinx_needs.utils import add_doc
 
 import sphinxcontrib.test_reports.directives.test_suite
 from sphinxcontrib.test_reports.directives.test_common import TestCommonDirective
@@ -139,4 +140,6 @@ def run(self):
 
                 main_section += suite_directive.run()
 
+        add_doc(self.env, docname)
+
         return main_section

sphinxcontrib/test_reports/directives/test_suite.py

@@ -3,6 +3,7 @@
 from docutils import nodes
 from docutils.parsers.rst import directives
 from sphinx_needs.api import add_need
+from sphinx_needs.utils import add_doc
 
 import sphinxcontrib.test_reports.directives.test_case
 from sphinxcontrib.test_reports.directives.test_common import TestCommonDirective
@@ -200,4 +201,6 @@ def run(self, nested=False, count=-1):
                 if is_nested:
                     case_count += 1
 
+        add_doc(self.env, docname)
+
         return main_section

tests/doc_test/needs_linking/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)

tests/doc_test/needs_linking/conf.py

@@ -0,0 +1,194 @@
+#
+# testreport 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 testreport a minimal Sphinx version, state it here.
+#
+# testreport_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.test_reports"]
+
+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",
+    },
+]
+
+# 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"
+
+needs_extra_options = ["asil", "uses_secure"]
+
+# General information about the project.
+project = "test-report 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 = "testreporttestdocsdoc"
+
+# -- 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,
+        "testreporttestdocs.tex",
+        "testreport 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,
+        "testreporttestdocs",
+        "testreport 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,
+        "testreporttestdocs",
+        "testreport test docs Documentation",
+        author,
+        "testreporttestdocs",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
+]

tests/doc_test/needs_linking/index.rst

@@ -0,0 +1,30 @@
+Basic Document FOR TEST FILE
+============================
+
+.. spec:: TEST_1
+   :id: TEST_1
+   :tags: A
+   :asil: D
+
+.. spec:: TEST_2
+   :id: TEST_2
+   :tags: A
+
+.. spec:: TEST_3
+   :id: TEST_3
+   :tags: A, B
+   :uses_secure: True
+
+.. spec:: TEST_4
+   :id: TEST_4
+   :tags: B
+   :uses_secure: True
+
+Need number with extra options: :need_count:`asil=='D'`
+
+Need number with extra options: :need_count:`uses_secure=='True'`
+
+
+.. toctree::
+
+   subfolder/file_1

tests/doc_test/needs_linking/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

tests/doc_test/needs_linking/subfolder/file_1.rst

@@ -0,0 +1,7 @@
+File
+====
+
+.. test-file:: My Test Data
+   :file: ../utils/xml_data.xml
+   :id: TESTFILE_1
+   :links: TEST_1

tests/test_needs_linking.py

@@ -0,0 +1,15 @@
+from pathlib import Path
+
+import pytest
+
+
+@pytest.mark.parametrize(
+    "test_app",
+    [{"buildername": "html", "srcdir": "doc_test/needs_linking"}],
+    indirect=True,
+)
+def test_doc_testsuites_html(test_app):
+    app = test_app
+    app.build()
+    html = Path(app.outdir, "index.html").read_text()
+    assert html