From 124c1e3d27d6c697cd06606f21c93c2bdb713df0 Mon Sep 17 00:00:00 2001 From: Scott Butler Date: Mon, 15 Aug 2016 17:48:46 -0700 Subject: [PATCH] Added substitution definitions and references for version number, etc --- docsite/conf.py | 19 +++++++++++++++++-- docsite/rst/index.rst | 2 +- 2 files changed, 18 insertions(+), 3 deletions(-) diff --git a/docsite/conf.py b/docsite/conf.py index b300813b25..5c3d18d771 100644 --- a/docsite/conf.py +++ b/docsite/conf.py @@ -28,7 +28,7 @@ import os sys.path.insert(0, os.path.join('ansible', 'lib')) sys.path.append(os.path.abspath('_themes')) -VERSION='0.01' +VERSION='2.1' AUTHOR='Ansible, Inc' @@ -55,7 +55,7 @@ master_doc = 'index' # General substitutions. project = 'Ansible Documentation' -copyright = "2013-2015 Ansible, Inc" +copyright = "2013-2016 Ansible, Inc" # The default replacements for |version| and |release|, also used in various # other places throughout the built documents. @@ -102,6 +102,21 @@ pygments_style = 'sphinx' highlight_language = 'yaml' +#Substitutions, variables, entities, & shortcuts for text which do not need to link to anything. +#For titles which should be a link, use the intersphinx anchors set at the index, chapter, and section levels, such as qi_start_: +rst_epilog = """ +.. |acapi| replace:: *Ansible Core API Guide* +.. |acrn| replace:: *Ansible Core Release Notes* +.. |ac| replace:: Ansible Core +.. |acversion| replace:: Ansible Core Version 2.1 +.. |acversionshort| replace:: Ansible Core 2.1 +.. |versionshortest| replace:: 2.1 +.. |versiondev| replace:: 2.2 +.. |pubdate| replace:: July 19, 2016 +.. |rhel| replace:: Red Hat Enterprise Linux + +""" + # Options for HTML output # ----------------------- diff --git a/docsite/rst/index.rst b/docsite/rst/index.rst index 4a11328a2f..313368108b 100644 --- a/docsite/rst/index.rst +++ b/docsite/rst/index.rst @@ -16,7 +16,7 @@ We believe simplicity is relevant to all sizes of environments, so we design for Ansible manages machines in an agent-less manner. There is never a question of how to upgrade remote daemons or the problem of not being able to manage systems because daemons are uninstalled. Because OpenSSH is one of the most peer-reviewed open source components, security exposure is greatly reduced. Ansible is decentralized--it relies on your existing OS credentials to control access to remote machines. If needed, Ansible can easily connect with Kerberos, LDAP, and other centralized authentication management systems. -This documentation covers the current released version of Ansible (2.0.1) and also some development version features (2.1). For recent features, we note in each section the version of Ansible where the feature was added. +This documentation covers the current released version of Ansible (|version|) and also some development version features (|versiondev|). For recent features, we note in each section the version of Ansible where the feature was added. Ansible, Inc. releases a new major release of Ansible approximately every two months. The core application evolves somewhat conservatively, valuing simplicity in language design and setup. However, the community around new modules and plugins being developed and contributed moves very quickly, typically adding 20 or so new modules in each release.