c4a8a6d3c2
Add an "all" category so all modules show up uncategorized there.
2014-01-02 17:42:18 -05:00
83d298accc
Add note about how to submit doc changes to generated module docs, limit TOC depth for module category list.
2013-12-25 21:29:54 -05:00
7965d331f3
do not produce too deep toc for category lists
2013-12-25 21:19:00 +02:00
af1f8db51d
remove trailing whitespaces
2013-12-25 21:19:00 +02:00
a5e8e10bb0
Removed unused things.
2013-12-25 14:17:47 -05:00
35ec9f81ae
Further modifications to the module formatter to adjust to the new theme, and some misc docs text corrections.
2013-12-25 13:24:29 -05:00
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
31d0060de8
Standardized on yml suffix, so fix this example content filename.
2013-12-25 13:24:29 -05:00
10009b0d3f
Starting to refactor module formatter script.
...
Rename "jpfunc" to something more explanatory
2013-12-25 13:24:29 -05:00
40429ee64e
Code to limit display of version_added attributions in modules for modules that are too old to call out this information.
...
This does not generically apply to new arguments added to existing modules, just the version_added attribute on the top level modules.
2013-11-27 21:34:00 -05:00
51e6f411f2
Docs: Fix the module formatter code that is intended to remove the 'historical' variable from showing up in version_added information (RST)
2013-11-27 21:14:38 -05:00
f7c3975f21
Add version_added to all modules missing version_added information, the docs formatter will now
...
raise errors when omitted, updated changelog with new modules.
2013-11-18 18:55:49 -05:00
af40b19a2d
Fix format string typo
2013-10-31 12:34:51 -05:00
5f18a53530
Fixup docs formatting.
2013-08-06 10:53:56 -04:00
fa9635478b
Fixing your YAML Seth :)
2013-07-15 13:16:37 -04:00
3f8aa8aec5
Fix up some module docs formatting errors.
2013-06-19 22:37:09 -04:00
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
9ca0289dee
Fixup the module formatter to explain the EXAMPLES string as well.
2013-05-11 16:32:22 -04:00
627b6a0455
Have 1.2 clear in docs
2013-05-02 11:31:51 -04:00
391fb98ee2
Allow modules to be categorized, and also sort them when generating the documentation.
2013-04-28 15:03:45 -04:00
148d8859ba
Docs on parameterized roles, make document generation output less noisy
2013-04-12 17:45:27 -04:00
a53259a797
Fixed option validation error
...
Fixed error on validation that block javascript documentation generation.
2013-03-29 16:30:33 +01:00
29aaa5e693
module_formatter.return_data: use UTF-8 encoding
...
The text parameter can contain non-ASCII characters, so we'll encode it
using UTF-8. For example the DOCUMENTATION of the bzr module has such
characters in the name of the author.
2013-03-17 19:55:56 +02: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
0ae7f996f5
Make sure all the lookup plugins are documented.
2013-02-02 11:51:25 -05:00
dd5a8474f8
Have module formatter ignore more types of files.
2012-11-26 18:50:26 -05:00
068ef0e979
module_formatter: re-instate code
2012-11-22 07:23:10 +01:00
caf003c813
DOCUMENTATION strings
2012-11-21 18:49:30 +01:00
e32f4a0564
Move get_docstring from module_formatter into ansible/utils
2012-11-09 17:15:41 +01:00
626203a7c9
Module documentation should have options sorted
2012-11-03 18:52:59 -04:00
afa467e975
DOCUMENTATION: LaTeX template is back
...
ongoing work for the Booklet
2012-10-24 19:42:52 +02:00
4104478abd
Added 'script', a module that can push and insantly run a remote script. Replaces the need to copy+command.
...
This is a bit of a rough draft, some error handling still needs to be added.
2012-10-20 12:12:07 -04:00
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
60f06c36b3
Miscellaneous fixes to module_formatter.py
...
Try to autodetect MODULEDIR, instead of hardcoded path in jpmens
homedir.
Check if MODULEDIR exists; exit if it doesn't.
Rewrite boilerplate() to use DOCUMENTATION.yaml in examples/. This
makes use of tbielawa's recent change that added this example file.
This also fixes -G so that it works. boilerplate() was commented out
before.
2012-10-12 16:27:01 -07:00
2786149bdc
Moving now from getopt to optparse
...
Let me know if we can move to another library instead ;-)
2012-10-11 18:14:38 +02:00
6d2f003ceb
Update formatter to not include orange blocks all over docsite page
2012-10-10 21:25:19 -04:00
110244d7b4
Merge branch 'remove-argparse' of git://github.com/dagwieers/ansible into devel
...
Conflicts:
hacking/module_formatter.py
Don't run webdocs build when building packages
2012-10-10 18:46:51 -04:00
ee679c0190
Unified document generator and make to generate JSON and JS files
2012-10-10 18:41:50 -04:00
2dcd0846ab
Use getopt instead of argparse
...
On RHEL5 and RHEL6 there is not argparse, and 'make rpm' fails because of this.
With this change it works, and I can test and fix my own documentation...
2012-10-09 12:23:30 +02:00
c3f443f56c
fix sorting
2012-10-04 07:08:13 -04:00
761330b125
Fix module formatter indexing
2012-10-03 23:31:50 -04:00
85fb7c6d4b
Library functions and modules should be in the 3 man page section. Also the files should end in '.3'
2012-10-03 10:18:55 -04:00
31a4fe412f
Complain when modules do not have documentation.
2012-09-30 21:10:07 -04:00
eb8a11237c
module_formatter can output lists of files to process (.rst and .tex)
2012-09-30 19:07:40 +02:00
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
94de4db928
Add JSON output format to DOCUMENTS and EXAMPLES parser
2012-09-28 22:38:27 +02:00
62d038dca4
module_formatter fixes
2012-09-28 09:59:43 +02:00
0c855a85bc
fix module formatter output messages
2012-09-27 21:34:28 -04: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
