Skip to content

Releases: leonhard-s/python-sphinx-highlighter

Version 0.3.0

05 Sep 16:57
Compare
Choose a tag to compare

Changes

  • Multi-word tag values (such as :param int y:) are now permitted. This is used by Sphinx autodoc to include the argument type in a single line:

    def foo(x, y):
        """
        :param int x: Argument with autodoc shorthand
    
        :param y: Argument with separate type tag
        :type y: int
        """

    Both variants are correct and highlighted when using this extension.

Bug fixes

  • Single character tag values (such as :param x:) are now recognized as tags

Version 0.2.0

18 May 10:44
Compare
Choose a tag to compare

Changes

  • The value portion of a named tag (such as :param arg:) is now selectable individually via the entity.name.tag.value.sphinx scope (#7)

Bug fixes

  • The closing colon of a Sphinx tag will now be correctly scoped as punctuation.definition.interpreted.sphinx (#8)

Version 0.1.1

28 Oct 17:33
Compare
Choose a tag to compare

Bugfixes

  • Parameters ending in numbers will now be highlighted properly (#4)
  • Fixed parameters using wildcard notation (*args, **kwargs) not being recognized as sphings tags (#4)
  • Inline formatting will no longer be applied when the control characters are surrounded by whitespace (#5)

Version 0.1.0

24 Apr 16:00
0f304b1
Compare
Choose a tag to compare

Initial version.

Some reStructuredText tags have been ignored due to the parsing complexity for unknown-indentation docstrings (e.g. code blocks or multiline literal block).