From 68e8bb16bbc833c76e7544d9f24fa75a67f4c009 Mon Sep 17 00:00:00 2001 From: Mrt134 Date: Thu, 8 Sep 2016 12:44:59 -0400 Subject: [PATCH] Add substitutions patch to conf.py for all handbooks. --- docs/api_reference/conf.py | 11 +++++++++++ docs/client_handbook/conf.py | 11 +++++++++++ docs/server_handbook/conf.py | 11 +++++++++++ 3 files changed, 33 insertions(+) diff --git a/docs/api_reference/conf.py b/docs/api_reference/conf.py index 83fa2e7..f968585 100644 --- a/docs/api_reference/conf.py +++ b/docs/api_reference/conf.py @@ -86,6 +86,17 @@ pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] +#Option to add text substitutions to all .rst files being built. +rst_prolog = """ +.. |freenas| replace:: FreeNAS"""u'\u00AE'""" +.. |truenas| replace:: TrueNAS"""u'\u00AE'""" +.. |pcbsd| replace:: PC-BSD"""u'\u00AE'""" +.. |trueos| replace:: TrueOS"""u'\u00AE'""" +.. |appcafe| replace:: AppCafe"""u'\u00AE'""" +.. |lumina| replace:: Lumina"""u'\u00AE'""" +.. |sysadm| replace:: SysAdm"""u'\u2122'""" +""" + # -- Option to change :menuselection: arrow ----------------------------- from docutils import nodes, utils diff --git a/docs/client_handbook/conf.py b/docs/client_handbook/conf.py index 49510e5..7a42747 100644 --- a/docs/client_handbook/conf.py +++ b/docs/client_handbook/conf.py @@ -120,6 +120,17 @@ pygments_style = 'sphinx' # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = True +#Option to add text substitutions to all .rst files being built. +rst_prolog = """ +.. |freenas| replace:: FreeNAS"""u'\u00AE'""" +.. |truenas| replace:: TrueNAS"""u'\u00AE'""" +.. |pcbsd| replace:: PC-BSD"""u'\u00AE'""" +.. |trueos| replace:: TrueOS"""u'\u00AE'""" +.. |appcafe| replace:: AppCafe"""u'\u00AE'""" +.. |lumina| replace:: Lumina"""u'\u00AE'""" +.. |sysadm| replace:: SysAdm"""u'\u2122'""" +""" + # -- Option to change :menuselection: arrow ----------------------------- from docutils import nodes, utils diff --git a/docs/server_handbook/conf.py b/docs/server_handbook/conf.py index d406273..62ea8e7 100644 --- a/docs/server_handbook/conf.py +++ b/docs/server_handbook/conf.py @@ -86,6 +86,17 @@ pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] +#Option to add text substitutions to all .rst files being built. +rst_prolog = """ +.. |freenas| replace:: FreeNAS"""u'\u00AE'""" +.. |truenas| replace:: TrueNAS"""u'\u00AE'""" +.. |pcbsd| replace:: PC-BSD"""u'\u00AE'""" +.. |trueos| replace:: TrueOS"""u'\u00AE'""" +.. |appcafe| replace:: AppCafe"""u'\u00AE'""" +.. |lumina| replace:: Lumina"""u'\u00AE'""" +.. |sysadm| replace:: SysAdm"""u'\u2122'""" +""" + # -- Option to change :menuselection: arrow ----------------------------- from docutils import nodes, utils