From d706aca82ba158351ca7507725c6ffac51382b9e Mon Sep 17 00:00:00 2001 From: Michael DeHaan Date: Sun, 9 Jun 2013 13:55:58 -0400 Subject: [PATCH] Merge --- docsite/latest/Makefile | 3 +- docsite/latest/_themes/aworks/layout.html | 41 +++++++++++++++++++ docsite/latest/_themes/aworks/relations.html | 8 ++++ docsite/latest/_themes/aworks/searchbox.html | 7 ++++ docsite/latest/_themes/aworks/sourcelink.html | 4 ++ docsite/latest/_themes/aworks/theme.conf | 5 +++ docsite/latest/build-site.py | 2 +- docsite/latest/conf.py | 6 +-- docsite/latest/rst/YAMLSyntax.rst | 4 -- docsite/latest/rst/api.rst | 5 --- docsite/latest/rst/bestpractices.rst | 5 --- docsite/latest/rst/contrib.rst | 5 --- docsite/latest/rst/examples.rst | 4 -- docsite/latest/rst/faq.rst | 4 -- docsite/latest/rst/gettingstarted.rst | 5 --- docsite/latest/rst/glossary.rst | 5 --- docsite/latest/rst/index.rst | 16 +++----- docsite/latest/rst/moduledev.rst | 5 --- docsite/latest/rst/modules.rst | 4 -- docsite/latest/rst/patterns.rst | 7 +--- docsite/latest/rst/playbooks.rst | 5 --- docsite/latest/rst/playbooks2.rst | 5 --- 22 files changed, 78 insertions(+), 77 deletions(-) create mode 100644 docsite/latest/_themes/aworks/layout.html create mode 100644 docsite/latest/_themes/aworks/relations.html create mode 100644 docsite/latest/_themes/aworks/searchbox.html create mode 100644 docsite/latest/_themes/aworks/sourcelink.html create mode 100644 docsite/latest/_themes/aworks/theme.conf diff --git a/docsite/latest/Makefile b/docsite/latest/Makefile index 3c75911343..8f480bfd03 100644 --- a/docsite/latest/Makefile +++ b/docsite/latest/Makefile @@ -11,9 +11,10 @@ viewdocs: clean ./build-site.py view htmldocs: - ./build-site.py rst + ./build-site.py rst clean: + -rm -rf htmlout -rm -f .buildinfo -rm -f *.inv -rm -rf *.doctrees diff --git a/docsite/latest/_themes/aworks/layout.html b/docsite/latest/_themes/aworks/layout.html new file mode 100644 index 0000000000..635a2e2b82 --- /dev/null +++ b/docsite/latest/_themes/aworks/layout.html @@ -0,0 +1,41 @@ + + +
+
+ +
+
+ +{% macro navBar() %} + +{% endmacro %} + +{# Silence the sidebar's, relbar's #} +{% block sidebar1 %}{% endblock %} +{% block sidebar2 %}{% endblock %} +{% block relbar1 %}{% endblock %} +{% block relbar2 %}{% endblock %} + +{%- block content %} +
+
+ + {% block header %}{{ navBar() }}{% endblock %} + + +
+ {% block body %} {% endblock %} +
+
+
+{%- endblock %} + + diff --git a/docsite/latest/_themes/aworks/relations.html b/docsite/latest/_themes/aworks/relations.html new file mode 100644 index 0000000000..b3df68e3b5 --- /dev/null +++ b/docsite/latest/_themes/aworks/relations.html @@ -0,0 +1,8 @@ +{%- if prev %} +
  • {{ "«"|safe }} {{ prev.title }}
  • +{%- endif %} +{%- if next %} +
  • {{ next.title }} {{ "»"|safe }}
  • +{%- endif %} diff --git a/docsite/latest/_themes/aworks/searchbox.html b/docsite/latest/_themes/aworks/searchbox.html new file mode 100644 index 0000000000..3063dde3d1 --- /dev/null +++ b/docsite/latest/_themes/aworks/searchbox.html @@ -0,0 +1,7 @@ +{%- if pagename != "search" %} +
    + + + +
    +{%- endif %} diff --git a/docsite/latest/_themes/aworks/sourcelink.html b/docsite/latest/_themes/aworks/sourcelink.html new file mode 100644 index 0000000000..21ae2d8fef --- /dev/null +++ b/docsite/latest/_themes/aworks/sourcelink.html @@ -0,0 +1,4 @@ +{%- if show_source and has_source and sourcename %} +
  • {{ _('Source') }}
  • +{%- endif %} diff --git a/docsite/latest/_themes/aworks/theme.conf b/docsite/latest/_themes/aworks/theme.conf new file mode 100644 index 0000000000..64f9efd569 --- /dev/null +++ b/docsite/latest/_themes/aworks/theme.conf @@ -0,0 +1,5 @@ +# Twitter Bootstrap Theme +[theme] +inherit = basic +stylesheet = basic.css +pygments_style = tango diff --git a/docsite/latest/build-site.py b/docsite/latest/build-site.py index b8ed1a9afe..05ed4aa135 100755 --- a/docsite/latest/build-site.py +++ b/docsite/latest/build-site.py @@ -45,7 +45,7 @@ class SphinxBuilder(object): try: buildername = 'html' - outdir = os.path.abspath(os.getcwd()) + outdir = os.path.abspath(os.path.join(os.getcwd(), "htmlout")) # Create the output directory if it doesn't exist if not os.access(outdir, os.F_OK): os.mkdir(outdir) diff --git a/docsite/latest/conf.py b/docsite/latest/conf.py index 2f8da64fdb..6c6aff2d65 100644 --- a/docsite/latest/conf.py +++ b/docsite/latest/conf.py @@ -101,8 +101,8 @@ pygments_style = 'sphinx' # ----------------------- html_theme_path = ['_themes'] -html_theme = 'bootstrap' -html_short_title = 'Ansible 1.2 Documentation' +html_theme = 'aworks' +html_short_title = 'Ansible Documentation' # The style sheet to use for HTML and HTML Help pages. A file of that name # must exist either in Sphinx' static/ path, or in one of the custom paths @@ -123,7 +123,7 @@ html_title = 'Ansible 1.2 Documentation' # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -html_favicon = 'favicon.ico' +#html_favicon = 'favicon.ico' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/docsite/latest/rst/YAMLSyntax.rst b/docsite/latest/rst/YAMLSyntax.rst index 66525fd043..b8fb861cbb 100644 --- a/docsite/latest/rst/YAMLSyntax.rst +++ b/docsite/latest/rst/YAMLSyntax.rst @@ -1,10 +1,6 @@ YAML Syntax =========== -.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png - :alt: ansiblefest 2013 - :target: http://ansibleworks.com/fest - 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/latest/rst/api.rst b/docsite/latest/rst/api.rst index 3c04c8902e..a726fc0f42 100644 --- a/docsite/latest/rst/api.rst +++ b/docsite/latest/rst/api.rst @@ -1,11 +1,6 @@ API & Integrations ================== -.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png - :alt: ansiblefest 2013 - :target: http://ansibleworks.com/fest - - 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, and you can plug in inventory data from external data sources. Ansible is written in its own diff --git a/docsite/latest/rst/bestpractices.rst b/docsite/latest/rst/bestpractices.rst index c0afa4488f..2456948548 100644 --- a/docsite/latest/rst/bestpractices.rst +++ b/docsite/latest/rst/bestpractices.rst @@ -1,11 +1,6 @@ Best Practices ============== -.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png - :alt: ansiblefest 2013 - :target: http://ansibleworks.com/fest/ - - Here are some tips for making the most of Ansible. 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 just yet). diff --git a/docsite/latest/rst/contrib.rst b/docsite/latest/rst/contrib.rst index 591579015b..1c0c19a227 100644 --- a/docsite/latest/rst/contrib.rst +++ b/docsite/latest/rst/contrib.rst @@ -1,11 +1,6 @@ Ansible Resources ================= -.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png - :alt: ansiblefest 2013 - :target: http://ansibleworks.com/fest - - User contributed playbooks, modules, and articles. This is a small curated list, but growing. Everyone is encouraged to add to this document, just `edit it on Github `_ diff --git a/docsite/latest/rst/examples.rst b/docsite/latest/rst/examples.rst index 4c8abf7d2e..625e915e7d 100644 --- a/docsite/latest/rst/examples.rst +++ b/docsite/latest/rst/examples.rst @@ -1,10 +1,6 @@ Command Line Examples And Next Steps ==================================== -.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png - :alt: ansiblefest 2013 - :target: http://ansibleworks.com/fest - .. highlight:: bash The following examples show how to use `/usr/bin/ansible` for running diff --git a/docsite/latest/rst/faq.rst b/docsite/latest/rst/faq.rst index b33620a291..b1f1e87d1d 100644 --- a/docsite/latest/rst/faq.rst +++ b/docsite/latest/rst/faq.rst @@ -1,10 +1,6 @@ Frequently Asked Questions ========================== -.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png - :alt: ansiblefest 2013 - :target: http://ansibleworks.com/fest - Here are some commonly-asked questions and their answers. .. contents:: diff --git a/docsite/latest/rst/gettingstarted.rst b/docsite/latest/rst/gettingstarted.rst index 99d30e5a4e..2db1bc963e 100644 --- a/docsite/latest/rst/gettingstarted.rst +++ b/docsite/latest/rst/gettingstarted.rst @@ -1,11 +1,6 @@ Getting Started =============== -.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png - :alt: ansiblefest 2013 - :target: http://ansibleworks.com/fest - - .. contents:: :depth: 2 :backlinks: top diff --git a/docsite/latest/rst/glossary.rst b/docsite/latest/rst/glossary.rst index 43ad4ececa..6faeb229cb 100644 --- a/docsite/latest/rst/glossary.rst +++ b/docsite/latest/rst/glossary.rst @@ -1,11 +1,6 @@ Glossary ======== -.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png - :alt: ansiblefest 2013 - :target: http://ansibleworks.com/fest - - 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 this in context, but this should be a good resource diff --git a/docsite/latest/rst/index.rst b/docsite/latest/rst/index.rst index d9d4406caf..a38ab4c2cf 100644 --- a/docsite/latest/rst/index.rst +++ b/docsite/latest/rst/index.rst @@ -3,19 +3,15 @@ Ansible Documentation Index ``````````````````````````` -.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png - :alt: ansiblefest 2013 - :target: http://ansibleworks.com/fest - Welcome to the Ansible documentation. This documentation covers the current released -version of Ansible (1.2) and may also reference some development version features (and if so, -such sections will be noted). +version of Ansible (1.2) and may also reference some development version features. + +For the previous released version, see `Ansible 1.1 Docs `_ instead. Before we dive into playbooks, configuration management, deployment, and orchestration, we'll learn how to get Ansible installed and some basic information. We'll go over how to execute ad-hoc commands in parallel across your nodes using /usr/bin/ansible. We'll also see what sort of modules are available in Ansible's core (though you can also write your own, which we'll also show later). - .. toctree:: :maxdepth: 1 @@ -27,10 +23,10 @@ what sort of modules are available in Ansible's core (though you can also write Overview ```````` -.. image:: http://ansible.cc/img/ansible_arch.png +.. image:: http://www.ansibleworks.com/wp-content/uploads/2013/06/ANSIBLE_DIAGRAM.jpg :alt: ansible architecture diagram - :width: 566px - :height: 439px + :width: 788px + :height: 436px Playbooks diff --git a/docsite/latest/rst/moduledev.rst b/docsite/latest/rst/moduledev.rst index 416a2df354..995f499376 100644 --- a/docsite/latest/rst/moduledev.rst +++ b/docsite/latest/rst/moduledev.rst @@ -1,11 +1,6 @@ Module Development ================== -.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png - :alt: ansiblefest 2013 - :target: http://ansibleworks.com/fest - - 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/latest/rst/modules.rst b/docsite/latest/rst/modules.rst index c2dc9b1f92..4bbf0ff23d 100644 --- a/docsite/latest/rst/modules.rst +++ b/docsite/latest/rst/modules.rst @@ -1,10 +1,6 @@ Ansible Modules =============== -.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png - :alt: ansiblefest 2013 - :target: http://ansibleworks.com/fest - .. contents:: :depth: 3 :backlinks: top diff --git a/docsite/latest/rst/patterns.rst b/docsite/latest/rst/patterns.rst index 0223cb21a8..9849ef4a29 100644 --- a/docsite/latest/rst/patterns.rst +++ b/docsite/latest/rst/patterns.rst @@ -3,16 +3,11 @@ Inventory & Patterns ==================== -.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png - :alt: ansiblefest 2013 - :target: http://ansibleworks.com/fest - - 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 /etc/ansible/hosts. -.. contents:: `Table of contents` +.. contents:: :depth: 2 :backlinks: top diff --git a/docsite/latest/rst/playbooks.rst b/docsite/latest/rst/playbooks.rst index 9cbfa49e51..359dc9bd14 100644 --- a/docsite/latest/rst/playbooks.rst +++ b/docsite/latest/rst/playbooks.rst @@ -1,11 +1,6 @@ Playbooks ========= -.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png - :alt: ansiblefest 2013 - :target: http://ansibleworks.com/fest - - .. contents:: :depth: 2 :backlinks: top diff --git a/docsite/latest/rst/playbooks2.rst b/docsite/latest/rst/playbooks2.rst index 67356cbf17..2dfc8e7622 100644 --- a/docsite/latest/rst/playbooks2.rst +++ b/docsite/latest/rst/playbooks2.rst @@ -1,11 +1,6 @@ Advanced Playbooks ================== -.. image:: http://ansible.cc/docs/_static/ansible_fest_2013.png - :alt: ansiblefest 2013 - :target: http://ansibleworks.com/fest - - Here are some advanced features of the playbooks language. Using all of these features are not neccessary, but many of them will prove useful. If a feature doesn't seem immediately relevant, feel free to skip it. For many people, the features documented in `playbooks` will