Commit Graph

48 Commits

Author SHA1 Message Date
b8321c74c8 Fix indentation of multiline descriptions 2016-11-02 17:55:21 -07:00
c16a88cac4 keep list as list in synopsis 2016-11-01 16:00:05 -04:00
fe09f7ee49 clarify that requirements are on host that runs it
fixes http://github.com/ansible/ansible-modules-core/issues/3061
2016-02-18 05:09:42 -08:00
173f27531c moar docs
added docs for new v2 features
restructures modules bar and core/extras info into their own pages
changed templates to refer to the new pages
added some missing ansible.cfg options
more info on gathering setting
2015-07-17 22:53:11 -04:00
6ba706f753 minor doc reformatting
now version_added < 1.3 does not get shown, up from 1.0
option's version_added is also now filterd against this threshold
module version_added is more prominent
exaples now uses pure rst instead of intermingled with html formatting
aliases now shown in description for options
bad version fields now throw warnings instead of exceptions
ansible-doc errors now show traceback in very very verbose mode, for easier debugging
2015-07-17 10:07:22 -04:00
0826106441 minor docs reformat
- clearer 'version added' for module options, now it sits under the option name
- made notes a section, so it now appears in toc
- moved requirements and made it a list, more prominent and more readable
2015-06-03 22:19:26 -04:00
85aa984340 Fix error in the column name in the doc 2015-05-15 01:05:38 -04:00
b6ec502983 added missing element to make google groups link a actual link 2015-03-24 21:09:45 -04:00
cf6155f1c2 rst.j2 template better core module source wording 2015-03-24 20:00:51 +01:00
c3076b8478 added module returnval documentation to web docs 2015-03-20 16:55:03 -04:00
2cacac4b23 minor adjustments to formatting 2015-03-20 16:55:03 -04:00
94909bd4a2 Added return values documentation to modules 2015-03-20 16:55:03 -04:00
b950a38e30 fix links to ansible-devel in documentation pages 2015-02-17 14:30:31 +03:00
650048f7dd now displays subcategories correctly 2014-11-03 22:02:13 -05:00
86de59235f bypass core/extras text when module is deprecated 2014-10-31 14:18:18 -04:00
8b5b97d066 now docs handle deprecated modules but still ignore aliases 2014-10-30 13:29:54 -04:00
1e12d3028c Merge pull request #9384 from insaneirish/devel
Change "usuable" to "usable".
2014-10-20 22:08:52 -04:00
3d257bc695 Change "usuable" to "usable". 2014-10-20 10:12:51 -04:00
e19f3f8a5c Typo: greatful -> grateful 2014-10-15 21:08:38 +02:00
2845f0c455 Typo: recieve -> receive. 2014-10-13 22:10:39 +02:00
2211ae113c Update rst.j2
typo fix
2014-09-29 18:01:16 -04:00
dc750e6526 Fix link in reST template
There was a missing trailing underscore (`_`) that would have marked the
content in the backticks as a link. This adds it and fixes the link on
every core module page.
2014-09-28 15:27:08 +02:00
ffee9a8fe0 Docsite formatting 2014-09-26 18:23:57 -04:00
e8fe306cef Some various comments about the new repos, more to likely come. 2014-09-26 17:52:50 -04:00
b818fbb305 Modules are almost always written now by mutliple authors, so don't show this field on website, since it grows obsolete and does not take into account all contributors.
Contributors are still listed on github module source and in repo, and original authors still in the file for when development questions arise, but want
to funnel support questions to the mailing list versus directly to them.
2014-09-10 09:42:24 -04:00
2f811c40d7 Basic docsite formatting fixups 2014-01-02 17:36:52 -05:00
84948292f3 include short_description in the module page's title 2013-12-26 14:35:57 -05:00
fce90e0370 use rst formatting for sphinx part 2013-12-25 21:20:11 +02:00
1713013dba provide sections and local TOC for module documentation 2013-12-25 21:19:00 +02:00
af1f8db51d remove trailing whitespaces 2013-12-25 21:19:00 +02:00
f4aa6c53bd Format module requirements as notes in Sphinx 2013-12-25 14:12:00 -05:00
eb0509fce7 Update the styling for the module pages slightly. 2013-12-25 14:06:55 -05:00
10009b0d3f Starting to refactor module formatter script.
Rename "jpfunc" to something more explanatory
2013-12-25 13:24:29 -05:00
88102df07c Show 'yes' and 'no' in choices on docs page. 2013-06-01 12:33:11 -04:00
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
ce67588dcf Fix module doc organization 2013-05-02 11:35:24 -04:00
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
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
626203a7c9 Module documentation should have options sorted 2012-11-03 18:52:59 -04:00
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
ad5433b166 include version added info for individual fields 2012-10-02 22:36:27 -04:00
f5e0fbf65b rst output template tweak for 'required' 2012-09-30 14:21:30 +02:00
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
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
62d038dca4 module_formatter fixes 2012-09-28 09:59:43 +02:00
405c097c43 Various fixes for the module documentation auto-generator 2012-09-27 21:30:32 -04:00
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
d47e15a1f2 module_formatter in hacking/ 2012-09-26 20:41:44 +02:00