Skip to content

Docs as code docs build tooling produces a lot of warning because of internal linking #354

@RolandJentschETAS

Description

@RolandJentschETAS

While build docs in docs-as-code a lot of warnings are visible about linking.

Warnings:

  • internals/requirements/requirements.rst:685: tool_req__docs_dd_link_source_code_link: references 'tool_req__docs_metamodel' as 'satisfies', but it must reference Process Requirements (gd_req) or Stakeholder Requirement (stkh_req).
  • ...

The background is, that in "docs/internals/requirements/requirements.rst"

The following rule is in:

.. needextend:: "metamodel.yaml" in source_code_link
  :+satisfies: tool_req__docs_metamodel
  :+tags: config

This rule adds this req to any data types in the meta model. Also to entries which does not contain "satisfy" links, which leads to the warning.

So the customer does not see probable his own warnings between all the others.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    Projects

    Status

    Draft

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions