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
47 lines
1.9 KiB
Plaintext
47 lines
1.9 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
|
|
|
|
.. Organization name
|
|
.. |org| replace:: StarlingX
|
|
|
|
.. Short and long product names such as "StarlingX" and "Acme Co. StarlingX"
|
|
.. |prod| replace:: StarlingX
|
|
.. |prod-long| replace:: StarlingX
|
|
.. |prod-os| replace:: StarlingX OpenStack
|
|
.. |prod-dc| replace:: Distributed Cloud
|
|
|
|
.. Guide names; will be formatted in italics by default.
|
|
.. |node-doc| replace:: :title:`StarlingX Node Configuration and Management`
|
|
.. |planning-doc| replace:: :title:`StarlingX Planning`
|
|
.. |sec-doc| replace:: :title:`StarlingX Security`
|
|
.. |inst-doc| replace:: :title:`StarlingX Installation`
|
|
.. |stor-doc| replace:: :title:`StarlingX Storage Configuration and Management`
|
|
.. |intro-doc| replace:: :title:`StarlingX Introduction`
|
|
.. |fault-doc| replace:: :title:`StarlingX Fault Management`
|
|
.. |sysconf-doc| replace:: :title:`StarlingX System Configuration`
|
|
.. |backup-doc| replace:: :title:`StarlingX Backup and Restore`
|
|
.. |deploy-doc| replace:: :title:`StarlingX Deployment Configurations`
|
|
.. |distcloud-doc| replace:: :title:`StarlingX Distributed Cloud`
|
|
.. |usertasks-doc| replace:: :title:`StarlingX User Tasks`
|
|
.. |admintasks-doc| replace:: :title:`StarlingX Administrator Tasks`
|
|
.. |datanet-doc| replace:: :title:`StarlingX Data Networks`
|
|
|
|
|
|
.. Name of downloads location
|
|
|
|
.. |dnload-loc| replace:: a StarlingX mirror
|
|
|
|
.. File name prefix, as in stx-remote-cli-<version>.tgz. May also be
|
|
used in sample domain names etc.
|
|
|
|
.. |prefix| replace:: stx
|
|
|
|
.. space character. Needed for padding in tabular output. Currently
|
|
used where |prefix| replacement is a length shorter than 3.
|
|
To insert a space, use "replace:: \ \" (with two spaces)
|
|
To insert no spaces, use "replace:: \"
|
|
|
|
.. |s| replace:: \
|