RST Documentation Trick for reference links

1 Jul
2022
1 Jul
'22
7:14 a.m.
Hello, I noticed myself writing things like: ``` and enable the eventlog using :rts-flag:`-l ⟨flags⟩`. ``` When in fact what I wanted was to create a link the eventlog options but render the link as just -l rather than -l <flags>.. but I thought I had to write the whole thing to get the linter to not complain. It turns out can achieve this goal using the following syntax: ``` and enable the eventlog using :rts-flag:`-l <-l ⟨flags⟩>`. ``` ie, include the thing you actually want to reference in angular brackets < > and the text you want to render before that. Yet another thing which has changed my life for good. Cheers, Matt
1055
Age (days ago)
1055
Last active (days ago)
0 comments
1 participants
participants (1)
-
Matthew Pickering