diff --git a/hacking/module_formatter.py b/hacking/module_formatter.py index 787bf4e2d2..5038b2e6ac 100755 --- a/hacking/module_formatter.py +++ b/hacking/module_formatter.py @@ -114,24 +114,6 @@ def write_data(text, options, outputname, module): ##################################################################################### -def boilerplate(): - ''' prints the boilerplate for module docs ''' - - if not os.path.exists(EXAMPLE_YAML): - print >>sys.stderr, "Missing example boiler plate: %s" % EXAMPLE_YAML - print "DOCUMENTATION = '''" - print file(EXAMPLE_YAML).read() - print "'''" - print "" - print "" - print "EXAMPLES = '''" - print "# example of doing ___ from a playbook" - print "your_module: some_arg=1 other_arg=2" - print "'''" - print "" - -##################################################################################### - def list_modules(module_dir): ''' returns a hash of categories, each category being a hash of module names to file paths ''' @@ -167,7 +149,6 @@ def generate_parser(): p.add_option("-v", "--verbose", action='store_true', default=False, help="Verbose") p.add_option("-o", "--output-dir", action="store", dest="output_dir", default=None, help="Output directory for module files") p.add_option("-I", "--includes-file", action="store", dest="includes_file", default=None, help="Create a file containing list of processed modules") - p.add_option("-G", "--generate", action="store_true", dest="do_boilerplate", default=False, help="generate boilerplate docs to stdout") p.add_option('-V', action='version', help='Show version number and exit') return p @@ -294,10 +275,6 @@ def process_category(category, categories, options, env, template, outputname): def validate_options(options): ''' validate option parser options ''' - if options.do_boilerplate: - boilerplate() - sys.exit(0) - if not options.module_dir: print >>sys.stderr, "--module-dir is required" sys.exit(1) diff --git a/hacking/templates/man.j2 b/hacking/templates/man.j2 deleted file mode 100644 index c85b14a2b1..0000000000 --- a/hacking/templates/man.j2 +++ /dev/null @@ -1,74 +0,0 @@ -.TH ANSIBLE.@{ module | upper }@ 3 "@{ now_date }@" "@{ ansible_version }@" "ANSIBLE MODULES" -.\" generated from @{ filename }@ -.SH NAME -@{ module }@ \- @{ short_description }@ -.\" ------ DESCRIPTION -.SH DESCRIPTION -{% for desc in description %} -.PP -@{ desc | convert_symbols_to_format }@ -{% endfor %} -.\" ------ OPTIONS -.\" -.\" -{% if options %} -.SH OPTIONS -{% for k in option_keys %} - {% set v = options[k] %} - -.IP @{ k }@ -{% for desc in v.description %}@{ desc | convert_symbols_to_format }@{% endfor %} -{% if v.get('choices') %} - -.IR Choices : -{% for choice in v.get('choices',[]) %}{% if choice == True %}yes{%elif choice == False %}no{% else %}@{ choice }@{% endif %}{% if not loop.last %},{%else%}.{%endif%}{% endfor %}{% endif %} -{% if v.get('required') %}(required){% endif %} -{% if v.get('default') %} (default: {% if v.get('default') == True %}yes{%elif v.get('default') == False %}no{% else %}@{ v.get('default') }@){% endif %}{% endif %} -{#---------------------------------------------- #} -{% if v.get('version_added') %} -(Added in Ansible version @{ v.get('version_added') }@.) -{% endif %} -{% endfor %} -{% endif %} -.\" -.\" -.\" ------ NOTES -{% if notes %} -.SH NOTES -{% for note in notes %} -.PP -@{ note | convert_symbols_to_format }@ -{% endfor %} -{% endif %} -.\" -.\" -.\" ------ EXAMPLES -{% if examples is defined %} -.SH EXAMPLES -{% for e in examples %} -.PP -{% if e['description'] %} -@{ e['description'] | convert_symbols_to_format }@ -{% endif %} - -.nf -@{ e['code'] }@ -.fi -{% endfor %} -{% endif %} -.\" ------ PLAINEXAMPLES -{% if plainexamples is defined %} -.SH EXAMPLES -.nf -@{ plainexamples }@ -.fi -{% endif %} - -.\" ------- AUTHOR -{% if author is defined %} -.SH AUTHOR -@{ author }@ -{% endif %} -.SH SEE ALSO -.IR ansible (1), -.I http://ansible.github.com/modules.html#@{docuri}@