Browse code

Docs rebuild in new project structure.

Michael DeHaan authored on 2012/10/08 21:09:27
Showing 45 changed files
... ...
@@ -62,7 +62,7 @@ tests:
62 62
 	PYTHONPATH=./lib nosetests -d -v
63 63
 
64 64
 # To force a rebuild of the docs run 'touch VERSION && make docs'
65
-docs: $(MANPAGES) modulepages
65
+docs: $(MANPAGES) modulepages docsite
66 66
 
67 67
 # Regenerate %.1.asciidoc if %.1.asciidoc.in has been modified more
68 68
 # recently than %.1.asciidoc.
... ...
@@ -162,3 +162,6 @@ deb: debian
162 162
 
163 163
 modulepages:
164 164
 	hacking/module_formatter.py -A $(VERSION) -t man -o docs/man/man3/ --module-dir=library --template-dir=hacking/templates
165
+
166
+docsite:
167
+	(cd docsite; make docs)
... ...
@@ -2,12 +2,12 @@
2 2
 .\"     Title: ansible
3 3
 .\"    Author: [see the "AUTHOR" section]
4 4
 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5
-.\"      Date: 09/06/2012
5
+.\"      Date: 10/08/2012
6 6
 .\"    Manual: System administration commands
7 7
 .\"    Source: Ansible 0.8
8 8
 .\"  Language: English
9 9
 .\"
10
-.TH "ANSIBLE" "1" "09/06/2012" "Ansible 0\&.8" "System administration commands"
10
+.TH "ANSIBLE" "1" "10/08/2012" "Ansible 0\&.8" "System administration commands"
11 11
 .\" -----------------------------------------------------------------
12 12
 .\" * set default formatting
13 13
 .\" -----------------------------------------------------------------
... ...
@@ -141,11 +141,6 @@ Sudo to
141 141
 instead of root\&. Implies \-\-sudo\&.
142 142
 .RE
143 143
 .PP
144
-\fB\-\-private\-key=\fR\fIPRIVATE_KEY_FILE\fR
145
-.RS 4
146
-Use this file to authenticate the connection\&.
147
-.RE
148
-.PP
149 144
 \fB\-c\fR \fICONNECTION\fR, \fB\-\-connection=\fR\fICONNECTION\fR
150 145
 .RS 4
151 146
 Connection type to use\&. Possible options are
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.APT 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.APT 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/apt
3 3
 .SH NAME
4 4
 apt \- Manages apt-packages
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.APT_REPOSITORY 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.APT_REPOSITORY 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/apt_repository
3 3
 .SH NAME
4 4
 apt_repository \- Manages apt repositores
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.ASSEMBLE 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.ASSEMBLE 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/assemble
3 3
 .SH NAME
4 4
 assemble \- Assembles a configuration file from fragments
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.ASYNC_STATUS 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.ASYNC_STATUS 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/async_status
3 3
 .SH NAME
4 4
 async_status \- Obtain status of asynchronous task
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.AUTHORIZED_KEY 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.AUTHORIZED_KEY 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/authorized_key
3 3
 .SH NAME
4 4
 authorized_key \- Adds or removes an SSH authorized key
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.COMMAND 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.COMMAND 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/command
3 3
 .SH NAME
4 4
 command \- Executes a command on a remote node
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.COPY 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.COPY 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/copy
3 3
 .SH NAME
4 4
 copy \- Copies files to remote locations.
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.EASY_INSTALL 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.EASY_INSTALL 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/easy_install
3 3
 .SH NAME
4 4
 easy_install \- Installs Python libraries
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.FACTER 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.FACTER 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/facter
3 3
 .SH NAME
4 4
 facter \- Runs the discovery program I(facter) on the remote system
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.FAIL 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.FAIL 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/fail
3 3
 .SH NAME
4 4
 fail \- Fail with custom message
... ...
@@ -12,7 +12,7 @@ This module fails the progress with a custom message. It can be useful for baili
12 12
 .SH OPTIONS
13 13
 
14 14
 .IP msg
15
-The customized message used for failing execution. If ommited, fail will simple bail out with a generic message. (default: Failed because only_if condition is true)
15
+The customized message used for failing execution. If ommited, fail will simple bail out with a generic message. (default: 'Failed because only_if condition is true')
16 16
 .IP rc
17 17
 The return code of the failure. This is currently not used by Ansible, but might be used in the future. (default: 1)."
18 18
 ."
... ...
@@ -23,7 +23,9 @@ The return code of the failure. This is currently not used by Ansible, but might
23 23
 .SH EXAMPLES
24 24
 .PP
25 25
 .nf
26
-[{'action': 'fail msg="The system may not be provisioned according to the CMDB status."', 'only_if': "'$cmdb_status' != 'to-be-staged'"}]
26
+action: fail msg="The system may not be provisioned according to the CMDB status." rc=100
27
+only_if: "'$cmdb_status' != 'to-be-staged'"
28
+
27 29
 .fi
28 30
 ." ------- AUTHOR
29 31
 .SH AUTHOR
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.FETCH 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.FETCH 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/fetch
3 3
 .SH NAME
4 4
 fetch \- Fetches a file from remote nodes
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.FILE 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.FILE 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/file
3 3
 .SH NAME
4 4
 file \- Sets attributes of files
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.FIREBALL 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.FIREBALL 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/fireball
3 3
 .SH NAME
4 4
 fireball \- Enable fireball mode on remote node
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.GET_URL 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.GET_URL 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/get_url
3 3
 .SH NAME
4 4
 get_url \- Downloads files from HTTP, HTTPS, or FTP to node
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.GIT 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.GIT 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/git
3 3
 .SH NAME
4 4
 git \- Deploy software (or files) from git checkouts
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.GROUP 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.GROUP 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/group
3 3
 .SH NAME
4 4
 group \- Add or remove groups
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.INI_FILE 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.INI_FILE 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/ini_file
3 3
 .SH NAME
4 4
 ini_file \- Tweak settings in INI files
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.LINEINFILE 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.LINEINFILE 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/lineinfile
3 3
 .SH NAME
4 4
 lineinfile \- Ensure a particular line is in a file
... ...
@@ -13,16 +13,16 @@ This is primarily useful when you want to change a single line in a file only. F
13 13
 ."
14 14
 .SH OPTIONS
15 15
 
16
+.IP insertafter
17
+Used with \fCstate=present\fR. If specified, the line will be inserted after the specified regular expression. Two special values are available; \fCBOF\fR for inserting the line at the beginning of the file, and \fCEOF\fR for inserting the line at the end of the file.
18
+.IR Choices :
19
+BOF,EOF. (default: EOF)
16 20
 .IP state
17 21
 Whether the line should be there or not.
18 22
 .IR Choices :
19 23
 present,absent. (default: present)
20
-.IP name
24
+.IP dest
21 25
 The file to modify(required)
22
-.IP insertafter
23
-Used with \fCstate=present\fR. If specified, the line will be inserted after the specified regular expression. Two special values are available; \fCBOF\fR for inserting the line at the beginning of the file, and \fCEOF\fR for inserting the line at the end of the file.
24
-.IR Choices :
25
-BOF,EOF. (default: EOF)
26 26
 .IP regexp
27 27
 The regular expression to look for in the file. For \fCstate=present\fR, the pattern to replace. For \fCstate=absent\fR, the pattern of the line to remove.(required)
28 28
 .IP line
... ...
@@ -37,11 +37,11 @@ Create a backup file including the timestamp information so you can get the orig
37 37
 .SH EXAMPLES
38 38
 .PP
39 39
 .nf
40
-lineinfile name=/etc/selinux/config regexp=^SELINUX= line=SELINUX=disabled
40
+lineinfile dest=/etc/selinux/config regexp=^SELINUX= line=SELINUX=disabled
41 41
 .fi
42 42
 .PP
43 43
 .nf
44
-lineinfile name=/etc/sudoers state=absent regexp="^%wheel"
44
+lineinfile dest=/etc/sudoers state=absent regexp="^%wheel"
45 45
 .fi
46 46
 ." ------- AUTHOR
47 47
 .SH AUTHOR
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.MOUNT 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.MOUNT 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/mount
3 3
 .SH NAME
4 4
 mount \- Control active and configured mount points
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.MYSQL_DB 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.MYSQL_DB 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/mysql_db
3 3
 .SH NAME
4 4
 mysql_db \- Add or remove MySQL databases from a remote host.
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.MYSQL_USER 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.MYSQL_USER 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/mysql_user
3 3
 .SH NAME
4 4
 mysql_user \- Adds or removes a user from a MySQL database.
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.NAGIOS 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.NAGIOS 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/nagios
3 3
 .SH NAME
4 4
 nagios \- Perform common tasks in Nagios related to downtime and notifications.
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.OHAI 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.OHAI 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/ohai
3 3
 .SH NAME
4 4
 ohai \- Returns inventory data from I(ohai)
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.PAUSE 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.PAUSE 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/pause
3 3
 .SH NAME
4 4
 pause \- Pause playbook execution
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.PING 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.PING 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/ping
3 3
 .SH NAME
4 4
 ping \- Try to connect to host and return pong on success.
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.PIP 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.PIP 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/pip
3 3
 .SH NAME
4 4
 pip \- Manages Python library dependencies.
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.POSTGRESQL_DB 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.POSTGRESQL_DB 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/postgresql_db
3 3
 .SH NAME
4 4
 postgresql_db \- Add or remove PostgreSQL databases from a remote host.
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.POSTGRESQL_USER 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.POSTGRESQL_USER 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/postgresql_user
3 3
 .SH NAME
4 4
 postgresql_user \- Adds or removes a users (roles) from a PostgreSQL database.
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.RAW 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.RAW 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/raw
3 3
 .SH NAME
4 4
 raw \- Executes a low-down and dirty SSH command
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.SEBOOLEAN 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.SEBOOLEAN 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/seboolean
3 3
 .SH NAME
4 4
 seboolean \- Toggles SELinux booleans.
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.SELINUX 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.SELINUX 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/selinux
3 3
 .SH NAME
4 4
 selinux \- Change policy and state of SELinux
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.SERVICE 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.SERVICE 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/service
3 3
 .SH NAME
4 4
 service \- Manage services.
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.SETUP 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.SETUP 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/setup
3 3
 .SH NAME
4 4
 setup \- Gathers facts about remote hosts
... ...
@@ -1,11 +1,11 @@
1
-.TH ANSIBLE.SHELL 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.SHELL 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/shell
3 3
 .SH NAME
4 4
 shell \- Execute commands in nodes.
5 5
 ." ------ DESCRIPTION
6 6
 .SH DESCRIPTION
7 7
 .PP
8
-The shell module takes the command name followed by a list of arguments, space delimited. It is almost exactly like the \fIcommand\fR module but runs the command through the user's configured shell on the remote node. 
8
+The shell module takes the command name followed by a list of arguments, space delimited. It is almost exactly like the \fIcommand\fR module but runs the command through a shell (\fC/bin/sh\fR) on the remote node. 
9 9
 ." ------ OPTIONS
10 10
 ."
11 11
 ."
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.SLURP 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.SLURP 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/slurp
3 3
 .SH NAME
4 4
 slurp \- Slurps a file from remote nodes
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.SUBVERSION 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.SUBVERSION 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/subversion
3 3
 .SH NAME
4 4
 subversion \- Deploys a subversion repository.
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.SUPERVISORCTL 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.SUPERVISORCTL 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/supervisorctl
3 3
 .SH NAME
4 4
 supervisorctl \- Manage the state of a program or group of programs running via Supervisord
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.TEMPLATE 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.TEMPLATE 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/template
3 3
 .SH NAME
4 4
 template \- Templates a file out to a remote server.
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.USER 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.USER 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/user
3 3
 .SH NAME
4 4
 user \- Manage user accounts
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.VIRT 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.VIRT 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/virt
3 3
 .SH NAME
4 4
 virt \- Manages virtual machines supported by libvirt
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.WAIT_FOR 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.WAIT_FOR 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/wait_for
3 3
 .SH NAME
4 4
 wait_for \- Waits for a given port to become accessible on a server.
... ...
@@ -1,4 +1,4 @@
1
-.TH ANSIBLE.YUM 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
1
+.TH ANSIBLE.YUM 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
2 2
 ." generated from library/yum
3 3
 .SH NAME
4 4
 yum \- Manages packages with the I(yum) package manager
... ...
@@ -25,9 +25,6 @@ clean:
25 25
 
26 26
 .PHONEY: docs clean
27 27
 
28
-#modules: $(FORMATTER) ../ansible/hacking/templates/rst.j2
29
-#	$(FORMATTER) -t rst --module-dir=../ansible/library -o rst/modules/
30
-
31 28
 modules: $(FORMATTER) ../ansible/hacking/templates/rst.j2
32 29
 	$(FORMATTER) -t rst --template-dir=../ansible/hacking/templates --module-dir=../ansible/library -o rst/modules/ --includes-file=rst/modules/_list.rst
33 30