From 041cea134f012ae3bcf1664f1a2cd8aa695ff6ad Mon Sep 17 00:00:00 2001 From: Michael DeHaan Date: Tue, 24 Dec 2013 17:29:28 -0500 Subject: [PATCH] New Sphinx theme has sidebar navigation so don't need TOC on each page. --- docsite/rst/YAMLSyntax.rst | 3 --- docsite/rst/developing_api.rst | 3 --- docsite/rst/developing_inventory.rst | 3 --- docsite/rst/developing_modules.rst | 3 --- docsite/rst/developing_plugins.rst | 3 --- docsite/rst/faq.rst | 3 --- docsite/rst/glossary.rst | 3 --- docsite/rst/guide_aws.rst | 3 --- docsite/rst/guide_rax.rst | 3 --- docsite/rst/guide_rolling_upgrade.rst | 3 --- docsite/rst/guide_vagrant.rst | 3 --- docsite/rst/intro_adhoc.rst | 3 --- docsite/rst/intro_configuration.rst | 3 --- docsite/rst/intro_dynamic_inventory.rst | 3 --- docsite/rst/intro_getting_started.rst | 3 --- docsite/rst/intro_installation.rst | 3 --- docsite/rst/intro_inventory.rst | 3 --- docsite/rst/intro_patterns.rst | 3 --- docsite/rst/playbooks.rst | 3 --- docsite/rst/playbooks_acceleration.rst | 3 --- docsite/rst/playbooks_async.rst | 3 --- docsite/rst/playbooks_best_practices.rst | 3 --- docsite/rst/playbooks_checkmode.rst | 3 --- docsite/rst/playbooks_conditionals.rst | 3 --- docsite/rst/playbooks_delegation.rst | 3 --- docsite/rst/playbooks_environment.rst | 3 --- docsite/rst/playbooks_error_handling.rst | 3 --- docsite/rst/playbooks_lookups.rst | 3 --- docsite/rst/playbooks_loops.rst | 3 --- docsite/rst/playbooks_prompts.rst | 3 --- docsite/rst/playbooks_roles.rst | 3 --- docsite/rst/playbooks_tags.rst | 3 --- docsite/rst/playbooks_variables.rst | 3 --- 33 files changed, 99 deletions(-) diff --git a/docsite/rst/YAMLSyntax.rst b/docsite/rst/YAMLSyntax.rst index 54874b6dde..3230a39f24 100644 --- a/docsite/rst/YAMLSyntax.rst +++ b/docsite/rst/YAMLSyntax.rst @@ -1,9 +1,6 @@ YAML Syntax =========== -.. contents:: - :depth: 2 - This page provides a basic overview of correct YAML syntax, which is how Ansible playbooks (our configuration management language) are expressed. diff --git a/docsite/rst/developing_api.rst b/docsite/rst/developing_api.rst index 95042574b2..da5ee9b1c8 100644 --- a/docsite/rst/developing_api.rst +++ b/docsite/rst/developing_api.rst @@ -13,9 +13,6 @@ as it has a very nice REST API that provides all of these things at a higher lev Ansible is written in its own API so you have a considerable amount of power across the board. This chapter discusses the Python API. -.. contents:: `Table of contents` - :depth: 2 - .. _python_api: Python API diff --git a/docsite/rst/developing_inventory.rst b/docsite/rst/developing_inventory.rst index 4a5af3012c..5fd8678517 100644 --- a/docsite/rst/developing_inventory.rst +++ b/docsite/rst/developing_inventory.rst @@ -1,9 +1,6 @@ Developing Dynamic Inventory Sources ==================================== -.. contents:: `Table of contents` - :depth: 2 - 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 5f9037f61e..1d5e9e4f81 100644 --- a/docsite/rst/developing_modules.rst +++ b/docsite/rst/developing_modules.rst @@ -13,9 +13,6 @@ Should you develop an interesting Ansible module, consider sending a pull reques `github project `_ to see about getting your module included in the core project. -.. contents:: - :depth: 2 - .. _module_dev_tutorial: Tutorial diff --git a/docsite/rst/developing_plugins.rst b/docsite/rst/developing_plugins.rst index 2829874d79..3e967f3136 100644 --- a/docsite/rst/developing_plugins.rst +++ b/docsite/rst/developing_plugins.rst @@ -1,9 +1,6 @@ Developing Plugins ================== -.. contents:: - :depth: 2 - 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/faq.rst b/docsite/rst/faq.rst index 17653ee082..9b8631d96a 100644 --- a/docsite/rst/faq.rst +++ b/docsite/rst/faq.rst @@ -3,9 +3,6 @@ Frequently Asked Questions Here are some commonly-asked questions and their answers. -.. contents:: - :depth: 2 - .. _users_and_ports: How do I handle different machines needing different user accounts or ports to log in with? diff --git a/docsite/rst/glossary.rst b/docsite/rst/glossary.rst index d64c26633e..8c10086b15 100644 --- a/docsite/rst/glossary.rst +++ b/docsite/rst/glossary.rst @@ -1,9 +1,6 @@ Glossary ======== -.. contents:: - :depth: 2 - The following is a list (and re-explanation) of term definitions used elsewhere in the Ansible documentation. Consult the documentation home page for the full documentation and to see the terms in context, but this should be a good resource diff --git a/docsite/rst/guide_aws.rst b/docsite/rst/guide_aws.rst index 0573528548..47ebdbb23c 100644 --- a/docsite/rst/guide_aws.rst +++ b/docsite/rst/guide_aws.rst @@ -1,9 +1,6 @@ Amazon Web Services Guide ========================= -.. contents:: - :depth: 2 - .. _aws_intro: Introduction diff --git a/docsite/rst/guide_rax.rst b/docsite/rst/guide_rax.rst index 40722c2ef3..762c700981 100644 --- a/docsite/rst/guide_rax.rst +++ b/docsite/rst/guide_rax.rst @@ -1,9 +1,6 @@ Rackspace Cloud Guide ===================== -.. contents:: - :depth: 3 - .. _introduction: Introduction diff --git a/docsite/rst/guide_rolling_upgrade.rst b/docsite/rst/guide_rolling_upgrade.rst index e578006f7b..bdaf1939ab 100644 --- a/docsite/rst/guide_rolling_upgrade.rst +++ b/docsite/rst/guide_rolling_upgrade.rst @@ -1,9 +1,6 @@ Continuous Delivery and Rolling Upgrades ======================================== -.. contents:: - :depth: 2 - .. _lamp_introduction: Introduction diff --git a/docsite/rst/guide_vagrant.rst b/docsite/rst/guide_vagrant.rst index 899735de85..4fb40d569f 100644 --- a/docsite/rst/guide_vagrant.rst +++ b/docsite/rst/guide_vagrant.rst @@ -1,9 +1,6 @@ Using Vagrant and Ansible ========================= -.. contents:: - :depth: 2 - .. _vagrant_intro: Introduction diff --git a/docsite/rst/intro_adhoc.rst b/docsite/rst/intro_adhoc.rst index 25b38a1583..7ed54f2dbb 100644 --- a/docsite/rst/intro_adhoc.rst +++ b/docsite/rst/intro_adhoc.rst @@ -31,9 +31,6 @@ port over directly to the playbook language. If you haven't read :doc:`intro_inventory` already, please look that over a bit first and then we'll get going. -.. contents:: - :depth: 2 - .. _parallelism_and_shell_commands: Parallelism and Shell Commands diff --git a/docsite/rst/intro_configuration.rst b/docsite/rst/intro_configuration.rst index f9eb3c9347..543b11cc48 100644 --- a/docsite/rst/intro_configuration.rst +++ b/docsite/rst/intro_configuration.rst @@ -15,9 +15,6 @@ The mechanism for doing this is the "ansible.cfg" file, which is looked for in t If multiple file locations matching the above exist, the last location on the above list is used. Settings in files are not merged together. -.. contents:: - :depth: 2 - .. _getting_the_latest_configuration: Getting the latest configuration diff --git a/docsite/rst/intro_dynamic_inventory.rst b/docsite/rst/intro_dynamic_inventory.rst index 52de7eb9a5..d1aa4cae5b 100644 --- a/docsite/rst/intro_dynamic_inventory.rst +++ b/docsite/rst/intro_dynamic_inventory.rst @@ -16,9 +16,6 @@ Ansible easily supports all of these options via an external inventory system. For information about writing your own dynamic inventory source, see :doc:`developing_inventory`. -.. contents:: - :depth: 2 - .. _cobbler_example: diff --git a/docsite/rst/intro_getting_started.rst b/docsite/rst/intro_getting_started.rst index f0f7b48cea..fc0c651951 100644 --- a/docsite/rst/intro_getting_started.rst +++ b/docsite/rst/intro_getting_started.rst @@ -1,9 +1,6 @@ Getting Started =============== -.. contents:: - :depth: 2 - .. _gs_about: About diff --git a/docsite/rst/intro_installation.rst b/docsite/rst/intro_installation.rst index 4ef2d23ef9..61ff6a6fe3 100644 --- a/docsite/rst/intro_installation.rst +++ b/docsite/rst/intro_installation.rst @@ -1,9 +1,6 @@ Installation ============ -.. contents:: - :depth: 2 - .. _getting_ansible: Getting Ansible diff --git a/docsite/rst/intro_inventory.rst b/docsite/rst/intro_inventory.rst index 3812ad35b8..5d22464776 100644 --- a/docsite/rst/intro_inventory.rst +++ b/docsite/rst/intro_inventory.rst @@ -12,9 +12,6 @@ Not only is this inventory configurable, but you can also use multiple inventory files at the same time (explained below) and also pull inventory from dynamic or cloud sources, as described in :doc:`intro_dynamic_inventory`. -.. contents:: - :depth: 2 - .. _inventoryformat: Hosts and Groups diff --git a/docsite/rst/intro_patterns.rst b/docsite/rst/intro_patterns.rst index f46a5f5a30..4504ef21ef 100644 --- a/docsite/rst/intro_patterns.rst +++ b/docsite/rst/intro_patterns.rst @@ -1,9 +1,6 @@ Patterns ++++++++ -.. contents:: - :depth: 2 - 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.rst b/docsite/rst/playbooks.rst index 6aa5f0cae6..b478ac5a60 100644 --- a/docsite/rst/playbooks.rst +++ b/docsite/rst/playbooks.rst @@ -1,9 +1,6 @@ Intro to Playbooks ================== -.. contents:: - :depth: 2 - .. _about_playbooks: About Playbooks diff --git a/docsite/rst/playbooks_acceleration.rst b/docsite/rst/playbooks_acceleration.rst index 52512c9e1d..2160cf6581 100644 --- a/docsite/rst/playbooks_acceleration.rst +++ b/docsite/rst/playbooks_acceleration.rst @@ -1,9 +1,6 @@ Accelerated Mode ================ -.. contents:: - :depth: 2 - .. versionadded:: 1.3 While OpenSSH using the ControlPersist feature is quite fast and scalable, there is a certain small amount of overhead involved in diff --git a/docsite/rst/playbooks_async.rst b/docsite/rst/playbooks_async.rst index 3a7013564a..d94a6986ba 100644 --- a/docsite/rst/playbooks_async.rst +++ b/docsite/rst/playbooks_async.rst @@ -1,9 +1,6 @@ Asynchronous Actions and Polling ================================ -.. contents:: - :depth: 2 - By default tasks in playbooks block, meaning the connections stay open until the task is done on each node. This may not always be desirable, or you may be running operations that take longer than the SSH timeout. diff --git a/docsite/rst/playbooks_best_practices.rst b/docsite/rst/playbooks_best_practices.rst index 49d14be55b..275a4d3ea5 100644 --- a/docsite/rst/playbooks_best_practices.rst +++ b/docsite/rst/playbooks_best_practices.rst @@ -5,9 +5,6 @@ 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:: - :depth: 2 - .. _content_organization: Content Organization diff --git a/docsite/rst/playbooks_checkmode.rst b/docsite/rst/playbooks_checkmode.rst index 555f682494..40ee15ff15 100644 --- a/docsite/rst/playbooks_checkmode.rst +++ b/docsite/rst/playbooks_checkmode.rst @@ -1,9 +1,6 @@ Check Mode ("Dry Run") ====================== -.. contents:: - :depth: 2 - .. versionadded:: 1.1 When ansible-playbook is executed with --check it will not make any changes on remote systems. Instead, any module diff --git a/docsite/rst/playbooks_conditionals.rst b/docsite/rst/playbooks_conditionals.rst index 84b6f1b135..ab5f1e08ef 100644 --- a/docsite/rst/playbooks_conditionals.rst +++ b/docsite/rst/playbooks_conditionals.rst @@ -1,9 +1,6 @@ Conditionals ============ -.. contents:: - :depth: 2 - 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 440228139a..86e67902c7 100644 --- a/docsite/rst/playbooks_delegation.rst +++ b/docsite/rst/playbooks_delegation.rst @@ -1,9 +1,6 @@ Delegation, Rolling Updates, and Local Actions ============================================== -.. contents:: - :depth: 2 - 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_environment.rst b/docsite/rst/playbooks_environment.rst index 4d02013a3b..971765ab30 100644 --- a/docsite/rst/playbooks_environment.rst +++ b/docsite/rst/playbooks_environment.rst @@ -1,9 +1,6 @@ Setting the Environment (and Working With Proxies) ================================================== -.. contents:: - :depth: 2 - .. versionadded:: 1.1 It is quite possible that you may need to get package updates through a proxy, or even get some package diff --git a/docsite/rst/playbooks_error_handling.rst b/docsite/rst/playbooks_error_handling.rst index d64917b05d..e4c5e413fe 100644 --- a/docsite/rst/playbooks_error_handling.rst +++ b/docsite/rst/playbooks_error_handling.rst @@ -1,9 +1,6 @@ Error Handling In Playbooks =========================== -.. contents:: - :depth: 2 - 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 a38232f5f9..d14645476e 100644 --- a/docsite/rst/playbooks_lookups.rst +++ b/docsite/rst/playbooks_lookups.rst @@ -1,9 +1,6 @@ Using Lookups ============= -.. contents:: - :depth: 2 - Lookup plugins allow access of data in Ansible from outside sources. This can include the filesystem but also external datastores. These values are then made available using the standard templating system in Ansible, and are typically used to load variables or templates with information from those systems. diff --git a/docsite/rst/playbooks_loops.rst b/docsite/rst/playbooks_loops.rst index cb766e5d7f..9b73c74473 100644 --- a/docsite/rst/playbooks_loops.rst +++ b/docsite/rst/playbooks_loops.rst @@ -1,9 +1,6 @@ Loops ===== -.. contents:: - :depth: 2 - Often you'll want to do many things in one task, such as create a lot of users, install a lot of packages, or repeat a polling step until a certain result is reached. diff --git a/docsite/rst/playbooks_prompts.rst b/docsite/rst/playbooks_prompts.rst index 427420d9d1..30fa51a843 100644 --- a/docsite/rst/playbooks_prompts.rst +++ b/docsite/rst/playbooks_prompts.rst @@ -1,9 +1,6 @@ Prompts ======= -.. contents:: - :depth: 2 - When running a playbook, you may wish to prompt the user for certain input, and can do so with the 'vars_prompt' section. diff --git a/docsite/rst/playbooks_roles.rst b/docsite/rst/playbooks_roles.rst index 2ac055b42e..4af68eb64c 100644 --- a/docsite/rst/playbooks_roles.rst +++ b/docsite/rst/playbooks_roles.rst @@ -1,9 +1,6 @@ Playbook Roles and Include Statements ===================================== -.. contents:: - :depth: 2 - Introduction ```````````` diff --git a/docsite/rst/playbooks_tags.rst b/docsite/rst/playbooks_tags.rst index 600ffa584e..c48ced2090 100644 --- a/docsite/rst/playbooks_tags.rst +++ b/docsite/rst/playbooks_tags.rst @@ -1,9 +1,6 @@ Tags ==== -.. contents:: - :depth: 2 - If you have a large playbook it may become useful to be able to run a specific part of the configuration without running the whole playbook. diff --git a/docsite/rst/playbooks_variables.rst b/docsite/rst/playbooks_variables.rst index 729affe562..8e17d68c83 100644 --- a/docsite/rst/playbooks_variables.rst +++ b/docsite/rst/playbooks_variables.rst @@ -21,9 +21,6 @@ and the "when" conditional can also be used with variables, and to help manage d It's highly recommended that you consult the ansible-examples github repository to see a lot of examples of variables put to use. -.. contents:: - :depth: 2 - .. _valid_variable_names: What Makes A Valid Variable Name