From e5baf5a926f946d5b1b78be9dd79044ae5005989 Mon Sep 17 00:00:00 2001 From: Michael DeHaan Date: Thu, 12 Apr 2012 21:38:47 -0400 Subject: [PATCH] Docs rebuild --- Makefile | 10 +-- YAMLSyntax.html | 1 - ansible-playbook.1.asciidoc | 97 ------------------------ ansible.1.asciidoc | 146 ------------------------------------ api.html | 1 - build-site.py | 11 --- examples.html | 1 - faq.html | 2 - genindex.html | 1 - gettingstarted.html | 1 - index.html | 6 -- man.html | 4 +- moduledev.html | 1 - modules.html | 1 - patterns.html | 1 - playbooks.html | 1 - rst/man.rst | 31 -------- search.html | 1 - searchindex.js | 2 +- 19 files changed, 4 insertions(+), 315 deletions(-) delete mode 100644 ansible-playbook.1.asciidoc delete mode 100644 ansible.1.asciidoc delete mode 100644 rst/man.rst diff --git a/Makefile b/Makefile index 4b89e54d2b..b487d7d4d0 100644 --- a/Makefile +++ b/Makefile @@ -1,20 +1,14 @@ #!/usr/bin/make -ASCII2HTMLMAN = a2x -D man/ -d manpage -f xhtml SITELIB = $(shell python -c "from distutils.sysconfig import get_python_lib; print get_python_lib()") all: clean docs -docs: clean htmlman +docs: clean ./build-site.py viewdocs: clean ./build-site.py view -htmlman: - mkdir -p man - $(ASCII2HTMLMAN) ansible.1.asciidoc - $(ASCII2HTMLMAN) ansible-playbook.1.asciidoc - htmldocs: ./build-site.py rst @@ -28,5 +22,5 @@ clean: find . -type f \( -name "*~" -or -name "#*" \) -delete find . -type f \( -name "*.swp" \) -delete -.PHONEY: docs manual clean +.PHONEY: docs clean diff --git a/YAMLSyntax.html b/YAMLSyntax.html index 4b814bf81f..d2dae1b921 100644 --- a/YAMLSyntax.html +++ b/YAMLSyntax.html @@ -121,7 +121,6 @@ s.parentNode.insertBefore(ga, s);
  • API & Integrations
  • Module Development Guide
  • Frequently Asked Questions
    • -
  • Man Pages
    • diff --git a/ansible-playbook.1.asciidoc b/ansible-playbook.1.asciidoc deleted file mode 100644 index 6a54b4353e..0000000000 --- a/ansible-playbook.1.asciidoc +++ /dev/null @@ -1,97 +0,0 @@ -ansible-playbook(1) -=================== -:doctype:manpage -:man source: Ansible -:man version: 0.0.1 -:man manual: System administration commands - -NAME ----- -ansible-playbook - run an ansible playbook - - -SYNOPSIS --------- -ansible-playbook ... [options] - - -DESCRIPTION ------------ - -*Ansible playbooks* are a configuration and multinode deployment -system. Ansible-playbook is the tool used to run them. See the -project home page (link below) for more information. - - -ARGUMENTS ---------- - -*filename.yml*:: - -The names of one or more YAML format files to run as ansible playbooks. - - -OPTIONS -------- - - -*-i* 'PATH', *--inventory=*'PATH':: - -The 'PATH' to the inventory hosts file, which defaults to '/etc/ansible/hosts'. - - -*-M* 'DIRECTORY', *--module-path=*'DIRECTORY':: - -The 'DIRECTORY' to load modules from. The default is '/usr/share/ansible'. - - -*-f* 'NUM', *--forks=*'NUM':: - -Level of parallelism. 'NUM' is specified as an integer, the default is 5. - - -*-k*, *--ask-pass*:: - -Prompt for the SSH password instead of assuming key-based authentication with ssh-agent. - - -*-T* 'SECONDS', *--timeout=*'SECONDS':: - -Connection timeout to use when trying to talk to hosts, in 'SECONDS'. - - -ENVIRONMENT ------------ - -The following environment variables may specified. - -ANSIBLE_HOSTS -- Override the default ansible hosts file - -ANSIBLE_LIBRARY -- Override the default ansible module library path - - -AUTHOR ------- - -Ansible was originally written by Michael DeHaan. See the AUTHORS file -for a complete list of contributors. - - -COPYRIGHT ---------- - -Copyright © 2012, Michael DeHaan - -Ansible is released under the terms of the GPLv3 License. - - -SEE ALSO --------- - -*ansible*(1) - -Extensive documentation as well as IRC and mailing list info -is available on the ansible home page: - - - diff --git a/ansible.1.asciidoc b/ansible.1.asciidoc deleted file mode 100644 index c7604cd328..0000000000 --- a/ansible.1.asciidoc +++ /dev/null @@ -1,146 +0,0 @@ -ansible(1) -========= -:doctype:manpage -:man source: Ansible -:man version: 0.0.1 -:man manual: System administration commands - -NAME ----- -ansible - run a command somewhere else - - -SYNOPSIS --------- -ansible [-f forks] [-m module_name] [-a args] - - -DESCRIPTION ------------ - -*Ansible* is an extra-simple tool/framework/API for doing \'remote things' over -SSH. - - -ARGUMENTS ---------- - -*host-pattern*:: - -A name of a group in the inventory file, a shell-like glob selecting -hosts in inventory file, or any combination of the two separated by -semicolons. - - -OPTIONS -------- - - -*-i* 'PATH', *--inventory=*'PATH':: - -The 'PATH' to the inventory hosts file, which defaults to '/etc/ansible/hosts'. - - -*-f* 'NUM', *--forks=*'NUM':: - -Level of parallelism. 'NUM' is specified as an integer, the default is 5. - - -*-m* 'NAME', *--module-name=*'NAME':: - -Execute the module called 'NAME'. - - -*-M* 'DIRECTORY', *--module-path=*'DIRECTORY':: - -The 'DIRECTORY' to load modules from. The default is '/usr/share/ansible'. - - -*-a* \'_ARGUMENTS_', *--args=*\'_ARGUMENTS_':: - -The 'ARGUMENTS' to pass to the module. - - -*-k*, *--ask-pass*:: - -Prompt for the SSH password instead of assuming key-based authentication with ssh-agent. - - -*-o*, *--one-line*:: - -Try to output everything on one line. - - -*-t* 'DIRECTORY', *--tree=*'DIRECTORY':: - -Save contents in this output 'DIRECTORY', with the results saved in a -file named after each host. - - -*-T* 'SECONDS', *--timeout=*'SECONDS':: - -Connection timeout to use when trying to talk to hosts, in 'SECONDS'. - - -*-B* 'NUM', *--background=*'NUM':: - -Run commands in the background, killing the task after 'NUM' seconds. - - -*-P* 'NUM', *--poll=*'NUM':: - -Poll a background job every 'NUM' seconds. Requires *-B*. - - -*-u* 'USERNAME', *--remote-user=*'USERNAME':: - -Use this remote 'USERNAME' instead of root. - - -INVENTORY ---------- - -Ansible stores the hosts it can potentially operate on in an inventory -file. The syntax is one host per line. Groups headers are allowed and -are included on their own line, enclosed in square brackets. - -FILES ------ - -/etc/ansible/hosts -- Default inventory file - -/usr/share/ansible/ -- Default module library - - -ENVIRONMENT ------------ - -The following environment variables may specified. - -ANSIBLE_HOSTS -- Override the default ansible hosts file - -ANSIBLE_LIBRARY -- Override the default ansible module library path - - -AUTHOR ------- - -Ansible was originally written by Michael DeHaan. See the AUTHORS file -for a complete list of contributors. - - -COPYRIGHT ---------- - -Copyright © 2012, Michael DeHaan - -Ansible is released under the terms of the GPLv3 License. - - -SEE ALSO --------- - -*ansible-playbook*(1) - -Extensive documentation as well as IRC and mailing list info -is available on the ansible home page: diff --git a/api.html b/api.html index dbc3cbd3d6..4cba99cbe4 100644 --- a/api.html +++ b/api.html @@ -121,7 +121,6 @@ s.parentNode.insertBefore(ga, s);
  • API & Integrations
  • Module Development Guide
  • Frequently Asked Questions
    • -
  • Man Pages
    • diff --git a/build-site.py b/build-site.py index b1e7dd6997..525ba35c4f 100755 --- a/build-site.py +++ b/build-site.py @@ -63,11 +63,6 @@ class SphinxBuilder(object): app.builder.build_all() - # We also have the HTML man pages to handle now as well - #if os.system("make htmlman"): - # print "There was an error while building the HTML man pages." - # print "Run 'make htmlman' to recreate the problem." - #print "Your docs are now in %s" % outdir except ImportError, ie: traceback.print_exc() except Exception, ex: @@ -80,11 +75,6 @@ class SphinxBuilder(object): def build_rst_docs(): docgen = SphinxBuilder() - -def build_html_manpages(): - os.system("make htmlman") - - if __name__ == '__main__': if '-h' in sys.argv or '--help' in sys.argv: print "This script builds the html documentation from rst/asciidoc sources.\n" @@ -100,7 +90,6 @@ if __name__ == '__main__': # By default, preform the rst->html transformation and then # the asciidoc->html trasnformation build_rst_docs() - build_html_manpages() if "view" in sys.argv: import webbrowser diff --git a/examples.html b/examples.html index 2a15d48a44..e58de36189 100644 --- a/examples.html +++ b/examples.html @@ -121,7 +121,6 @@ s.parentNode.insertBefore(ga, s);
  • API & Integrations
  • Module Development Guide
  • Frequently Asked Questions
    • -
  • Man Pages
    • diff --git a/faq.html b/faq.html index b4811dab81..eea46718bc 100644 --- a/faq.html +++ b/faq.html @@ -27,7 +27,6 @@ - -