search

zephyriot / zep-jira14

0 stars 0 forks source link

Enable Sphinx option doc_role='any' for improved reference linking #2245

Open nashif opened 7 years ago

nashif commented 7 years ago

Reported by David Kinder:

Sphinx supports automatic hunting for any defined reference and linking to it for items enclosed with single back-ticks, instead of requiring :ref:reference name or other interpreted text roles.

Alas, folks have been using single back-ticks in places where they should have used double back-ticks to indicate inline code formatting. In order to enable the desired behavior for single back-tick uses, the offending uses would all need to be found and changed to use double-back ticks (about 100 cases). Note that there are good cases of single back-tick uses that would properly link to the referenced item so we don't just want to replace all uses of single back-ticks.

(Imported from Jira ZEP-2414)

nashif commented 7 years ago

by David Kinder:

PR https://github.com/zephyrproject-rtos/zephyr/pull/974 fixes uses of single-quotes that would have caused errors if we enable the default role "any".