Skip to content

Commit 001d5ed

Browse files
committed
[nrf fromlist] doc: doxygen: remove rst utilities
We no longer render Doxygen content in Sphinx after the removal of breathe, so let's remove rst related aliases from Doxyfile. Also adjust some headers that contained rst content. Upstream PR: zephyrproject-rtos/zephyr#80362 Signed-off-by: Gerard Marull-Paretas <[email protected]> (cherry picked from commit b8cd03a1e512229cd60dc70b2cd038a087b808bb)
1 parent 06d6b00 commit 001d5ed

File tree

3 files changed

+143
-211
lines changed

3 files changed

+143
-211
lines changed

doc/zephyr.doxyfile.in

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -279,24 +279,22 @@ TAB_SIZE = 8
279279
# with the commands \{ and \} for these it is advised to use the version @{ and
280280
# @} or use a double escape (\\{ and \\})
281281

282-
ALIASES = "rst=\verbatim embed:rst:leading-asterisk" \
283-
endrst=\endverbatim \
284-
"kconfig{1}=\htmlonly <code>\1</code> \endhtmlonly \xmlonly <verbatim>embed:rst:inline :kconfig:option:`\1`</verbatim> \endxmlonly" \
282+
ALIASES = "kconfig{1}=\verbatim \1 \endverbatim" \
285283
"req{1}=\ref ZEPH_\1 \"ZEPH-\1\"" \
286284
"satisfy{1}=\xrefitem satisfy \"Satisfies requirement\" \"Requirement Implementation\" \1" \
287285
"verify{1}=\xrefitem verify \"Verifies requirement\" \"Requirement Verification\" \1" \
288286
"kconfig_dep{1}=\attention Available only when the following Kconfig option is enabled: \kconfig{\1}." \
289287
"kconfig_dep{2}=\attention Available only when the following Kconfig options are enabled: \kconfig{\1}, \kconfig{\2}." \
290288
"kconfig_dep{3}=\attention Available only when the following Kconfig options are enabled: \kconfig{\1}, \kconfig{\2}, \kconfig{\3}." \
291289
"funcprops=\par \"Function properties (list may not be complete)\"" \
292-
"reschedule=\htmlonly reschedule \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_reschedule`</verbatim> \endxmlonly" \
293-
"sleep=\htmlonly sleep \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_sleep`</verbatim> \endxmlonly" \
294-
"no_wait=\htmlonly no-wait \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_no-wait`</verbatim> \endxmlonly" \
295-
"isr_ok=\htmlonly isr-ok \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_isr-ok`</verbatim> \endxmlonly" \
296-
"pre_kernel_ok=\htmlonly pre-kernel-ok \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_pre-kernel-ok`</verbatim> \endxmlonly" \
297-
"async=\htmlonly async \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_async`</verbatim> \endxmlonly" \
290+
"reschedule=\qualifier reschedule" \
291+
"sleep=\qualifier sleep" \
292+
"no_wait=\qualifier no-wait" \
293+
"isr_ok=\qualifier isr-ok" \
294+
"pre_kernel_ok=\qualifier pre-kernel-ok" \
295+
"async=\qualifier async" \
298296
"atomic_api=As for all atomic APIs, includes a full/sequentially-consistent memory barrier (where applicable)." \
299-
"supervisor=\htmlonly supervisor \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_supervisor`</verbatim> \endxmlonly"
297+
"supervisor=\qualifier supervisor"
300298

301299
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
302300
# only. Doxygen will then generate output that is more tailored for C. For

0 commit comments

Comments
 (0)