Merge pull request #1219 from tbielawa/move_modulepages

Library functions and modules should be in the 3 man page section. Also ...

Makefile

@@ -9,7 +9,7 @@
 #   make deb ------------------ produce a DEB
 #   make docs ----------------- rebuild the manpages (results are checked in)
 #   make tests ---------------- run the tests
-#   make pyflakes, make pep8 -- source code checks  
+#   make pyflakes, make pep8 -- source code checks
 
 ########################################################
 # variable section
@@ -58,7 +58,7 @@ RPMNVR = "$(NAME)-$(VERSION)-$(RPMRELEASE)$(RPMDIST)"
 
 all: clean python
 
-tests: 
+tests:
 	PYTHONPATH=./lib nosetests -d -v
 
 # To force a rebuild of the docs run 'touch VERSION && make docs'
@@ -161,4 +161,4 @@ deb: debian
 # for arch or gentoo, read instructions in the appropriate 'packaging' subdirectory directory
 
 modulepages:
-	hacking/module_formatter.py -A $(VERSION) -t man -o docs/man/man1/ --module-dir=library --template-dir=hacking/templates
+	hacking/module_formatter.py -A $(VERSION) -t man -o docs/man/man3/ --module-dir=library --template-dir=hacking/templates

hacking/module_formatter.py

@@ -148,7 +148,7 @@ def get_docstring(filename, verbose=False):
             if isinstance(child, ast.Assign):
                 if 'DOCUMENTATION' in (t.id for t in child.targets):
                     doc = yaml.load(child.value.s)
-                 
+
     except:
         if verbose:
             raise
@@ -210,7 +210,7 @@ def main():
 
     module_dir = None
     args = p.parse_args()
-    
+
     # print "M: %s" % args.module_dir
     # print "t: %s" % args.type
     # print "m: %s" % args.module_list
@@ -251,7 +251,7 @@ def main():
     if args.type == 'man':
         env.filters['jpfunc'] = man_ify
         template = env.get_template('man.j2')
-        outputname = "ansible.%s.man"
+        outputname = "ansible.%s.3"
         includecmt = ""
         includefmt = ""
     if args.type == 'rst':
@@ -330,7 +330,7 @@ def main():
 #
 #    # Sneaky: insert author's name from Git config
 #
-#    cmd = subprocess.Popen("git config --get user.name", shell=True, 
+#    cmd = subprocess.Popen("git config --get user.name", shell=True,
 #            stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 #    out, err = cmd.communicate()
 #

packaging/rpm/ansible.spec

@@ -40,8 +40,9 @@ are transferred to managed machines automatically.
 mkdir -p $RPM_BUILD_ROOT/etc/ansible/
 cp examples/hosts $RPM_BUILD_ROOT/etc/ansible/
 cp examples/ansible.cfg $RPM_BUILD_ROOT/etc/ansible/
-mkdir -p $RPM_BUILD_ROOT/%{_mandir}/man1/
+mkdir -p $RPM_BUILD_ROOT/%{_mandir}/{man1,man3}/
 cp -v docs/man/man1/*.1 $RPM_BUILD_ROOT/%{_mandir}/man1/
+cp -v docs/man/man3/*.3 $RPM_BUILD_ROOT/%{_mandir}/man3/
 mkdir -p $RPM_BUILD_ROOT/%{_datadir}/ansible
 cp -v library/* $RPM_BUILD_ROOT/%{_datadir}/ansible/
 
@@ -56,6 +57,7 @@ rm -rf $RPM_BUILD_ROOT
 %config(noreplace) %{_sysconfdir}/ansible
 %doc README.md PKG-INFO COPYING
 %doc %{_mandir}/man1/ansible*
+%doc %{_mandir}/man3/ansible.*
 %doc examples/playbooks
 
 %changelog