This is an extension for Visual Studio Code designed to improve readbility of Python docstrings using the the Sphinx docstring format.
The source code shown is the the example from the Read the Docs Sphinx docstring format introduction.
Sphinx docstrings are compact and can easily be converted into HTML or PDF documentation using Sphinx and its Autodoc extension, but are generally harder to work with in the source code.
This extension alleviates this drawback by highlighting select Sphinx and reStructuredText directives within Python docstrings.
This extension is only compatible with the default VS Code Python extension. It is not compatible with Python for VSCode, see #6 for details.
- Parameters ending in numbers will now be highlighted properly (#4)
- Fixed parameters using wildcard notation (
*args,**kwargs) not being recognized as sphinx tags (#4) - Inline formatting will no longer be applied when the control characters are surrounded by whitespace (#5)
Initial release