76 lines
1.8 KiB
Plaintext
76 lines
1.8 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
|
|
|
|
.. Load scoped product information
|
|
.. include:: /_this.txt
|
|
|
|
.. Load custom roles
|
|
.. include:: /shared/roles.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
|
|
|
|
.. Common version numbers
|
|
|
|
.. |kube-ver| replace:: 1.23.1
|
|
|
|
|
|
.. 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>
|
|
|
|
.. |html-comment| raw:: html
|
|
|
|
<!---->
|
|
|
|
.. |html-pipe| raw:: html
|
|
|
|
|
|
|
|
|
.. Supress substring on per-page basis. Use in conjuction with
|
|
.. :hideable:`don't show this` text.
|
|
|
|
.. |hideable| raw:: html
|
|
|
|
<style>
|
|
.hideable {
|
|
display:none;
|
|
}
|
|
</style>
|
|
|
|
|
|
.. |optional| replace:: **Optional step:**
|
|
|
|
.. Flag to mark an output html file for post-build step to hide empty rows
|
|
in tables. This is mostly useful where some rows are conditionalized.
|
|
|
|
.. |hide-empty-rows| raw:: html
|
|
|
|
<!-- post-build-hide-empty-table-rows --> |