cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
8142 commits 47 branches 390 tags 440 MiB
Commit graph

38 commits

Author SHA1 Message Date
Mikhail Sobolev
84948292f3 include short_description in the module page's title 2013-12-26 14:35:57 -05:00
Mikhail Sobolev
fce90e0370 use rst formatting for sphinx part 2013-12-25 21:20:11 +02:00
Mikhail Sobolev
1713013dba provide sections and local TOC for module documentation 2013-12-25 21:19:00 +02:00
Mikhail Sobolev
af1f8db51d remove trailing whitespaces 2013-12-25 21:19:00 +02:00
Michael DeHaan
a5e8e10bb0 Removed unused things. 2013-12-25 14:17:47 -05:00
Michael DeHaan
f4aa6c53bd Format module requirements as notes in Sphinx 2013-12-25 14:12:00 -05:00
Michael DeHaan
eb0509fce7 Update the styling for the module pages slightly. 2013-12-25 14:06:55 -05:00
Michael DeHaan
fe2d00d9d3 WIP on refactoring the module formatter code that we use to build the doc site with. 2013-12-25 13:24:29 -05:00
Michael DeHaan
10009b0d3f Starting to refactor module formatter script. 
Rename "jpfunc" to something more explanatory
 2013-12-25 13:24:29 -05:00
Michael Vogt
b8e641136a make comment lines in troff start with .\" and add a .SH EXAMPLES to the PLAINEXAMPLES section 2013-11-01 09:20:05 +01:00
Dale Sedivec
7681b1ce68 Improve Markdown (and other) module doc output 
- The html_ify filter now escapes HTML found in module documentation.
  THIS COULD AFFECT MORE THAN JUST MARKDOWN but I didn't see any modules
  expecting to use e.g. HTML entities or HTML tags in their
  documentation.

- The markdown_ify filter (used as jpfunc in markdown.j2) escapes at
  least a few Markdown in-line formatting characters.

- Improvements to markdown.j2:

    - Call jpfunc on the module name heading so that it gets escaped for
      Markdown (e.g. my_module_name becomes my\_module\_name).

    - Added paragraph breaks between paragraphs in the description.

    - Added examples heading, which is consistent with the notes heading
      below it.
 2013-06-14 13:27:59 -05:00
Michael DeHaan
88102df07c Show 'yes' and 'no' in choices on docs page. 2013-06-01 12:33:11 -04:00
Jan-Piet Mens
eeb80c695f Add Requirements to rst template, ansible-doc 
tweak position & look of Requirements in rst
tweak APT's notes as per anhj's wish
 2013-05-11 16:46:59 +02:00
Michael DeHaan
ce67588dcf Fix module doc organization 2013-05-02 11:35:24 -04:00
Jan-Piet Mens
396a07bcc7 Add support for additional EXAMPLES string in Ansible modules 
return DOC and EXAMPLES as a list
add moduledev explanation
more
 2013-02-18 20:02:46 +01:00
Dag Wieers
66fb7fd9de Make use of yes/no booleans in playbooks 
At the moment Ansible prefers yes/no for module booleans, however booleans in playbooks are still using True/False, rather than yes/no. This changes modifies boolean uses in playbooks (and man pages) to favor yes/no rather than True/False.

This change includes:

- Adaptation of documentation and examples to favor yes/no
- Modification to manpage output to favor yes/no (the docsite output already favors yes/no)
 2012-12-14 11:56:53 +01:00
Jan-Piet Mens
f9755ca36d mail module: add MIME attachments, port and addresses with phrases 
Add HTML-escaping to code examples in rST tempate of module-formatter
 Add support for specifying port, addresses with phrases and attaching files
 Add support for custom headers and document version_added for new options
 X-Mailer header added :)
 protect empty address lists & attachment list, and add bcc
 2012-12-12 07:42:42 +01:00
Michael DeHaan
6a5df97393 Manpage documentation ALSO should be sorted 2012-11-03 18:54:38 -04:00
Michael DeHaan
626203a7c9 Module documentation should have options sorted 2012-11-03 18:52:59 -04:00
Jan-Piet Mens
afa467e975 DOCUMENTATION: LaTeX template is back 
ongoing work for the Booklet
 2012-10-24 19:42:52 +02:00
Michael DeHaan
896be48ac9 Merge pull request #1367 from jpmens/mdtempl 
Add support for Github-flavored Markdown to module_formatter
 2012-10-18 16:59:18 -07:00
Jan-Piet Mens
575459465e module_formatter: .rst now correctly handles code examples 
- fixed template (it was the template), adding indentation with Jinja2
 - added description of code examples to man-page template (was missing)
 - fixed fireball, cron, and debug module examples to confrom
 2012-10-18 13:49:19 +02:00
Jan-Piet Mens
d4f89122f4 Add support for Github-flavored Markdown to module_formatter 
- Uses HTML tables and Github-flavored code blocks (3 backticks)
 2012-10-18 07:34:17 +02:00
Marco Vito Moscaritolo
ee679c0190 Unified document generator and make to generate JSON and JS files 2012-10-10 18:41:50 -04:00
Jan-Piet Mens
ba22ca13ba man pages have wrong chapter number 2012-10-05 09:09:49 +02:00
Michael DeHaan
ad5433b166 include version added info for individual fields 2012-10-02 22:36:27 -04:00
Jan-Piet Mens
e4338d0ca3 module_formatter now also uses Jinja2 trim_blocks 
- Updated man template accordingly
- seem to have left in illegal char in facter DOCUMENTATION...
 2012-09-30 15:06:18 +02:00
Jan-Piet Mens
f5e0fbf65b rst output template tweak for 'required' 2012-09-30 14:21:30 +02:00
Michael DeHaan
b96da3e5b0 Merge pull request #1158 from jpmens/man01 
documentation: man template: support empty options; add Version
 2012-09-30 05:00:39 -07:00
Jan-Piet Mens
61ee632d23 documentation: man template: support empty options; add Version to Makefile 2012-09-30 13:33:21 +02:00
Jan-Piet Mens
80a9016636 module docs: fixed rst template 
- notes is now supported
- multiline code examples are now supported (HTML rendering was off)
 2012-09-30 13:20:24 +02:00
Michael DeHaan
508e6ecf43 Merge pull request #1131 from jpmens/m-docs3 
Module DOCUMENTATION for template, wait_for, and yum
 2012-09-28 16:11:33 -07:00
Jan-Piet Mens
a040807fd0 Module DOCUMENTATION for template, wait_for, and yum 2012-09-29 00:49:02 +02:00
Jan-Piet Mens
e0fb264a89 Module DOCUMENTATION: assemble, authorized_key, command, copy 
plus a small fix in rst.j2 template
  manpages generated & checked
  modules.html generated & checked
 2012-09-28 21:55:49 +02:00
Jan-Piet Mens
62d038dca4 module_formatter fixes 2012-09-28 09:59:43 +02:00
Michael DeHaan
405c097c43 Various fixes for the module documentation auto-generator 2012-09-27 21:30:32 -04:00
Michael DeHaan
83f277cfe6 Various tweaking to get the module formatter to work for 'make docs' in the docs project. Likely the templates for other module formatting types will have to change 
by the time I'm done.
 2012-09-27 21:06:31 -04:00
Jan-Piet Mens
d47e15a1f2 module_formatter in hacking/ 2012-09-26 20:41:44 +02:00