Michael DeHaan
2f811c40d7
Basic docsite formatting fixups
2014-01-02 17:36:52 -05:00
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
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
10009b0d3f
Starting to refactor module formatter script.
...
Rename "jpfunc" to something more explanatory
2013-12-25 13:24:29 -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
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
626203a7c9
Module documentation should have options sorted
2012-11-03 18:52:59 -04: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
Michael DeHaan
ad5433b166
include version added info for individual fields
2012-10-02 22:36:27 -04:00
Jan-Piet Mens
f5e0fbf65b
rst output template tweak for 'required'
2012-09-30 14:21:30 +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
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
