Skip to content

useblock libraries that dynamically register directives have to be placed in ubc ignore_directives #56

@MrChocolateMoose

Description

@MrChocolateMoose

Describe the bug
It is a bit unexpected to have to add explicit code like this in my ubproject.toml once I start using all of the sphinx-addons together (codelinks, test-reports):

[parse]
ignore_directives = [
  "src-trace",
  "test-case",
  etc
]

I know that the needs defined in the toml and those defined by the sphinx add-ons work differently, but these libraries are advertised as what I should use for the use case (testing, source code tracing).

This is a very minor issue for me, and I am already working around it using the above, but I wanted to report it anyways.

To Reproduce

  • Set up sphinx-codelinks and/or sphinx-test-reports in your repo.
  • Set up ubc to lint on pre-commit or run manually
  • It will complain on files using test directives or trace directives

Expected behavior

  • Nothing needs to be added and ubc and ubcode have knowledge to ignore or to know more about useblocks addons

Screenshots

UBC documentation linting................................................Failed
- hook id: ubc-check
- duration: 1.31s

UBC license information retrieved successfully
UBC license is valid until XXX
UBC licenses in use: XXX
UBC license is active
Running UBC check on 1 file(s)...
Using config file: /home/XX/XX/ubproject.toml
Processing new files... ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1/1 0:00:00
[block.directive_unknown]
   --> XX/YY/ZZ/
   Unknown directive: 'test-case'
...

Desktop (please complete the following information):

  • OS: ubuntu 22.04LTS
  • Architecture x64
  • ubCode version: 0.20.1b

Additional context
Add any other context about the problem here.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions