diff --git a/docsite/rst/developing_api.rst b/docsite/rst/developing_api.rst index da5ee9b1c8c..15f9755e365 100644 --- a/docsite/rst/developing_api.rst +++ b/docsite/rst/developing_api.rst @@ -1,6 +1,8 @@ Python API ========== +.. contents:: Topics + There are several interesting ways to use Ansible from an API perspective. You can use the Ansible python API to control nodes, you can extend Ansible to respond to various python events, you can write various plugins, and you can plug in inventory data from external data sources. This document diff --git a/docsite/rst/developing_inventory.rst b/docsite/rst/developing_inventory.rst index 5fd86785174..760ad80db9c 100644 --- a/docsite/rst/developing_inventory.rst +++ b/docsite/rst/developing_inventory.rst @@ -1,6 +1,8 @@ Developing Dynamic Inventory Sources ==================================== +.. contents:: Topics + As described in `intro_inventory_dynamic`, ansible can pull inventory information from dynamic sources, including cloud sources. How do we write a new one? diff --git a/docsite/rst/developing_modules.rst b/docsite/rst/developing_modules.rst index 5ce843352dd..d9892774fe8 100644 --- a/docsite/rst/developing_modules.rst +++ b/docsite/rst/developing_modules.rst @@ -1,6 +1,8 @@ Developing Modules ================== +.. contents:: Topics + Ansible modules are reusable units of magic that can be used by the Ansible API, or by the `ansible` or `ansible-playbook` programs. diff --git a/docsite/rst/developing_plugins.rst b/docsite/rst/developing_plugins.rst index 3e967f31362..32ff187cabe 100644 --- a/docsite/rst/developing_plugins.rst +++ b/docsite/rst/developing_plugins.rst @@ -1,6 +1,8 @@ Developing Plugins ================== +.. contents:: Topics + Ansible is pluggable in a lot of other ways separate from inventory scripts and callbacks. Many of these features are there to cover fringe use cases and are infrequently needed, and others are pluggable simply because they are there to implement core features in ansible and were most convenient to be made pluggable. diff --git a/docsite/rst/intro_adhoc.rst b/docsite/rst/intro_adhoc.rst index 7ed54f2dbb1..ba1033d061f 100644 --- a/docsite/rst/intro_adhoc.rst +++ b/docsite/rst/intro_adhoc.rst @@ -1,6 +1,8 @@ Introduction To Ad-Hoc Commands =============================== +.. contents:: Topics + .. highlight:: bash The following examples show how to use `/usr/bin/ansible` for running diff --git a/docsite/rst/intro_configuration.rst b/docsite/rst/intro_configuration.rst index 543b11cc48d..b4f675f414d 100644 --- a/docsite/rst/intro_configuration.rst +++ b/docsite/rst/intro_configuration.rst @@ -1,6 +1,8 @@ The Ansible Configuration File ++++++++++++++++++++++++++++++ +.. contents:: Topics + .. highlight:: bash Certain things in Ansible are adjustable in a configuration file. In general, the stock configuration is probably diff --git a/docsite/rst/intro_dynamic_inventory.rst b/docsite/rst/intro_dynamic_inventory.rst index d1aa4cae5b4..11a2dda9a59 100644 --- a/docsite/rst/intro_dynamic_inventory.rst +++ b/docsite/rst/intro_dynamic_inventory.rst @@ -3,6 +3,8 @@ Dynamic Inventory ================= +.. contents:: Topics + Often a user of a configuration management system will want to keep inventory in a different software system. Ansible provides a basic text-based system as described in :doc:`intro_inventory` but what if you want to use something else? diff --git a/docsite/rst/intro_getting_started.rst b/docsite/rst/intro_getting_started.rst index fc0c6519512..ae1172d3075 100644 --- a/docsite/rst/intro_getting_started.rst +++ b/docsite/rst/intro_getting_started.rst @@ -1,10 +1,12 @@ Getting Started =============== +.. contents:: Topics + .. _gs_about: -About -````` +Foreword +```````` Now that you've read :doc:`intro_installation` and installed Ansible, it's time to dig in and get started with some commands. diff --git a/docsite/rst/intro_inventory.rst b/docsite/rst/intro_inventory.rst index 5d224647761..604603d516b 100644 --- a/docsite/rst/intro_inventory.rst +++ b/docsite/rst/intro_inventory.rst @@ -3,6 +3,8 @@ Inventory ========= +.. contents:: Topics + Ansible works against multiple systems in your infrastructure at the same time. It does this by selecting portions of systems listed in Ansible's inventory file, which defaults to being saved in diff --git a/docsite/rst/intro_patterns.rst b/docsite/rst/intro_patterns.rst index 4504ef21ef0..7d8ebe0f528 100644 --- a/docsite/rst/intro_patterns.rst +++ b/docsite/rst/intro_patterns.rst @@ -1,6 +1,8 @@ Patterns ++++++++ +.. contents:: Topics + Patterns in Ansible are how we decide which hosts to manage. This can mean what hosts to communicate with, but in terms of :doc:`playbooks` it actually means what hosts to apply a particular configuration or IT process to. diff --git a/docsite/rst/playbooks_best_practices.rst b/docsite/rst/playbooks_best_practices.rst index 275a4d3ea59..efa4a4cc321 100644 --- a/docsite/rst/playbooks_best_practices.rst +++ b/docsite/rst/playbooks_best_practices.rst @@ -5,6 +5,8 @@ Here are some tips for making the most of Ansible playbooks. You can find some example playbooks illustrating these best practices in our `ansible-examples repository `_. (NOTE: These may not use all of the features in the latest release, but are still an excellent reference!). +.. contents:: Topics + .. _content_organization: Content Organization diff --git a/docsite/rst/playbooks_checkmode.rst b/docsite/rst/playbooks_checkmode.rst index 40ee15ff15c..cc34ff5bdfc 100644 --- a/docsite/rst/playbooks_checkmode.rst +++ b/docsite/rst/playbooks_checkmode.rst @@ -3,6 +3,8 @@ Check Mode ("Dry Run") .. versionadded:: 1.1 +.. contents:: Topics + When ansible-playbook is executed with --check it will not make any changes on remote systems. Instead, any module instrumented to support 'check mode' (which contains most of the primary core modules, but it is not required that all modules do this) will report what changes they would have made rather than making them. Other modules that do not support check mode will also take no action, but just will not report what changes they might have made. diff --git a/docsite/rst/playbooks_conditionals.rst b/docsite/rst/playbooks_conditionals.rst index ab5f1e08ef1..75daad2e4ca 100644 --- a/docsite/rst/playbooks_conditionals.rst +++ b/docsite/rst/playbooks_conditionals.rst @@ -1,6 +1,9 @@ Conditionals ============ +.. contents:: Topics + + Often the result of a play may depend on the value of a variable, fact (something learned about the remote system), or previous task result. In some cases, the values of variables may depend on other variables. Further, additional groups can be created to manage hosts based on diff --git a/docsite/rst/playbooks_delegation.rst b/docsite/rst/playbooks_delegation.rst index 86e67902c7c..535d2e97bb0 100644 --- a/docsite/rst/playbooks_delegation.rst +++ b/docsite/rst/playbooks_delegation.rst @@ -1,6 +1,8 @@ Delegation, Rolling Updates, and Local Actions ============================================== +.. contents:: Topics + Being designed for multi-tier deployments since the beginning, Ansible is great at doing things on one host on behalf of another, or doing local steps with reference to some remote hosts. This in particular this is very applicable when setting up continuous deployment infrastructure or zero downtime rolling updates, where you might be talking with load balancers or monitoring systems. diff --git a/docsite/rst/playbooks_error_handling.rst b/docsite/rst/playbooks_error_handling.rst index e4c5e413fee..af5c021da50 100644 --- a/docsite/rst/playbooks_error_handling.rst +++ b/docsite/rst/playbooks_error_handling.rst @@ -1,6 +1,8 @@ Error Handling In Playbooks =========================== +.. contents:: Topics + Ansible normally has defaults that make sure to check the return codes of commands and modules and it fails fast -- forcing an error to be dealt with unless you decide otherwise. diff --git a/docsite/rst/playbooks_lookups.rst b/docsite/rst/playbooks_lookups.rst index d14645476e2..52ddaedb19b 100644 --- a/docsite/rst/playbooks_lookups.rst +++ b/docsite/rst/playbooks_lookups.rst @@ -7,6 +7,8 @@ in Ansible, and are typically used to load variables or templates with informati .. note:: This is considered an advanced feature, and many users will probably not rely on these features. +.. contents:: Topics + .. _getting_file_contents: Intro to Lookups: Getting File Contents diff --git a/docsite/rst/playbooks_loops.rst b/docsite/rst/playbooks_loops.rst index 9b73c74473d..672b7f51074 100644 --- a/docsite/rst/playbooks_loops.rst +++ b/docsite/rst/playbooks_loops.rst @@ -6,6 +6,8 @@ repeat a polling step until a certain result is reached. This chapter is all about how to use loops in playbooks. +.. contents:: Topics + .. _standard_loops: Standard Loops diff --git a/docsite/rst/playbooks_roles.rst b/docsite/rst/playbooks_roles.rst index 4af68eb64cb..05fd681f26b 100644 --- a/docsite/rst/playbooks_roles.rst +++ b/docsite/rst/playbooks_roles.rst @@ -1,6 +1,8 @@ Playbook Roles and Include Statements ===================================== +.. contents:: Topics + Introduction ```````````` diff --git a/docsite/rst/playbooks_variables.rst b/docsite/rst/playbooks_variables.rst index 8e17d68c838..9d25a958735 100644 --- a/docsite/rst/playbooks_variables.rst +++ b/docsite/rst/playbooks_variables.rst @@ -1,6 +1,8 @@ Variables ========= +.. contents:: Topics + While automation exists to make it easier to make things repeatable, all of your systems are likely not exactly alike. All of your systems are likely not the same. On some systems you may want to set some behavior