Skip to content
This repository was archived by the owner on Sep 26, 2024. It is now read-only.
This repository was archived by the owner on Sep 26, 2024. It is now read-only.

How to disable needs.json warning #47

@marcel-22

Description

@marcel-22

Here some thoughts about some Sphinx-Needs-Vscode warnings. I was wondering about the following IDE warnings:
SNV: sphinx-needs.srcDir not configured.
SNV: sphinx-needs.needsJson path not configured.

How is this supposed to work for projects that no use any needs? Should a project add a dummy needs.json file and reference that to silence the warning? The VS code extension is installed for every workspace/project, but not every workspace/project might need and use needs definitions.

Also, when a project that DOES have needs is opened for the first time and the documentation has not been build yet, the IDE extension generates the warning: SNV: Given sphinx-needs.needsJson path: docs/_build/html/needs.json not exists. Isn't this kind of a no-brainer? For me, the warning seems to tell me there is something wrong, but in fact there isn't. The Sphinx-Needs explorer view could display this text message instead. Maybe a tighter integration with Esbonio could solve this issue by using the needs.json from the Esbonio output, but I am not sure how the Esbonio output file can be found within Sphinx-Needs-Vscode.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions