inmanta / inmanta-sphinx

Sphinx domains for Inmanta docs
0 stars 0 forks source link

Pygments Lexer breaks on valid inmanta models #51

Closed arnaudsjs closed 2 years ago

arnaudsjs commented 2 years ago

The lexer fails to parse inmanta models where an entity contains an attribute of type string[]?. This causes issues for code snippets where embedded entities set the string[]? __lsm_key_attributes attribute. The result is that these code block do not get the inmanta syntax highlighting in the documentation.

The above-mentioned in issue exists for the file: docs/moduleguides/lsm/embedded_entities/embedded_entities_sources/example_key_attributes.cf. But similar issue may exists in other places. Related warnings found in the output of the ISO documentation build:

docs/moduleguides/lsm/allocation/allocation.rst:39: WARNING: Could not lex literal_block as "inmanta". Highlighting skipped.
docs/moduleguides/lsm/allocation/allocation.rst:88: WARNING: Could not lex literal_block as "inmanta". Highlighting skipped.
docs/moduleguides/lsm/allocation/allocation.rst:157: WARNING: Could not lex literal_block as "inmanta". Highlighting skipped.
docs/moduleguides/lsm/allocation/allocation_v2.rst:19: WARNING: Could not lex literal_block as "inmanta". Highlighting skipped.
docs/moduleguides/lsm/allocation/allocation_v2.rst:107: WARNING: Could not lex literal_block as "inmanta". Highlighting skipped.
docs/moduleguides/lsm/allocation/allocation_v2.rst:140: WARNING: Could not lex literal_block as "inmanta". Highlighting skipped.
docs/moduleguides/lsm/embedded_entities/embedded_entities.rst:126: WARNING: Could not lex literal_block as "inmanta". Highlighting skipped.
wouterdb commented 2 years ago

Hey team! Please add your planning poker estimate with ZenHub @andraskvr @arnaudsjs @FloLey @Hugo-Inmanta