abf0cd1b68
Additional abbreviations and product names. New 'minitoc' substitution for use in page contents lists. e.g: .. contents:: |minitoc| :depth: 1 Broke out abbreviations into separate file. Broke out vendor-specific substitutions into separate file to improve reuse of common substitutions. Changes to doc/source/configuration/intel_n3000_fpga.rst to demonstrate |minitoc| and some incidental clean-up. Signed-off-by: Stone <ronald.stone@windriver.com> Change-Id: I7546e1d59feff213d397341ebde95351bd9ae834
37 lines
1.1 KiB
Plaintext
37 lines
1.1 KiB
Plaintext
.. Common string substitutions for brand customization and consistency.
|
|
.. NOTE: Do not use underscores in these substitution names.
|
|
.. For more information, see
|
|
.. https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#substitutions
|
|
|
|
|
|
.. Load vendor-specific strings
|
|
.. include:: /_vendor/vendor_strings.txt
|
|
|
|
.. Load abbreviations list
|
|
.. include:: /shared/abbrevs.txt
|
|
|
|
|
|
.. Task-oriented headings that should not appear in TOC
|
|
.. These are used with the .. rubric:: directive. For example:
|
|
.. .. rubric:: |postreq|
|
|
|
|
.. |context| replace:: About this task
|
|
.. |prereq| replace:: Prerequisites
|
|
.. |proc| replace:: Procedure
|
|
.. |postreq| replace:: Postrequisites
|
|
.. |result| replace:: Results
|
|
.. |eg| replace:: Example
|
|
|
|
.. File-level minitoc label. Used with .. contents:: directive, as in
|
|
.. .. contents:: |minitoc|
|
|
.. :depth: 1
|
|
|
|
.. |minitoc| replace:: **In this section:**
|
|
|
|
.. Table row alternation inline override. Alternation styling is confused
|
|
.. by spans. Applies to all tables in an rST file.
|
|
|
|
.. |row-alt-off| raw:: html
|
|
|
|
<style>table.docutils tr.row-odd {background-color: #fff;}</style>
|