Bug 442900 - [Feature request] Optional reStructuredText syntax highlighting for inline Python documentation
Summary: [Feature request] Optional reStructuredText syntax highlighting for inline Py...
Status: RESOLVED REMIND
Alias: None
Product: frameworks-syntax-highlighting
Classification: Frameworks and Libraries
Component: syntax (show other bugs)
Version: 5.86.0
Platform: Other Linux
: NOR wishlist
Target Milestone: ---
Assignee: KWrite Developers
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2021-09-24 14:34 UTC by geisserml
Modified: 2023-01-01 16:30 UTC (History)
1 user (show)

See Also:
Latest Commit:
Version Fixed In:
Sentry Crash Report:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description geisserml 2021-09-24 14:34:04 UTC
SUMMARY
Many Python projects use inline code documentation with sphinx-autodoc, since this is a lot less maintenance work than separate code documentation.
This way, it is much easier to keep code and docs consistent, especially as method parameter headers are generated automatically.

STEPS TO REPRODUCE
1. Open a Python file with inline Sphinx reStructuredText documentation in Kate

OBSERVED RESULT
The Python code is syntax-highlighted. The inline rst markup is not highlighted, however.

EXPECTED RESULT
It would be nice to have optional rst syntax highlighting for inline code documentation indicated with `""" documentation text here """`.

SOFTWARE/OS VERSIONS
Operating System: KDE neon 5.22
KDE Plasma Version: 5.22.5
KDE Frameworks Version: 5.86.0
Qt Version: 5.15.3
Kernel Version: 5.11.0-36-generic (64-bit)
Graphics Platform: Wayland
Processors: 4 × Intel® Core™ i5-3570K CPU @ 3.40GHz
Memory: 7.2 GiB of RAM
Graphics Processor: Mesa DRI Intel® HD Graphics 4000

ADDITIONAL INFORMATION
Perhaps this idea is a bit far-fetched and/or hard to implement, so this is really just a suggestion.
Comment 1 geisserml 2023-01-01 16:30:11 UTC
Closing as I'm not using KDevelop anymore.