Michael DeHaan
5f18a53530
Fixup docs formatting.
11 years ago
Michael DeHaan
fa9635478b
Fixing your YAML Seth :)
12 years ago
Michael DeHaan
3f8aa8aec5
Fix up some module docs formatting errors.
12 years ago
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.
12 years ago
Michael DeHaan
9ca0289dee
Fixup the module formatter to explain the EXAMPLES string as well.
12 years ago
Michael DeHaan
627b6a0455
Have 1.2 clear in docs
12 years ago
Michael DeHaan
391fb98ee2
Allow modules to be categorized, and also sort them when generating the documentation.
12 years ago
Michael DeHaan
148d8859ba
Docs on parameterized roles, make document generation output less noisy
12 years ago
Marco Vito Moscaritolo
a53259a797
Fixed option validation error
...
Fixed error on validation that block javascript documentation generation.
12 years ago
Cristian Ciupitu
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.
12 years ago
Jan-Piet Mens
396a07bcc7
Add support for additional EXAMPLES string in Ansible modules
...
return DOC and EXAMPLES as a list
add moduledev explanation
more
12 years ago
Michael DeHaan
0ae7f996f5
Make sure all the lookup plugins are documented.
12 years ago
Michael DeHaan
dd5a8474f8
Have module formatter ignore more types of files.
12 years ago
Jan-Piet Mens
068ef0e979
module_formatter: re-instate code
12 years ago
Jan-Piet Mens
caf003c813
DOCUMENTATION strings
12 years ago
Jan-Piet Mens
e32f4a0564
Move get_docstring from module_formatter into ansible/utils
12 years ago
Michael DeHaan
626203a7c9
Module documentation should have options sorted
12 years ago
Jan-Piet Mens
afa467e975
DOCUMENTATION: LaTeX template is back
...
ongoing work for the Booklet
12 years ago
Michael DeHaan
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.
12 years ago
Jan-Piet Mens
d4f89122f4
Add support for Github-flavored Markdown to module_formatter
...
- Uses HTML tables and Github-flavored code blocks (3 backticks)
12 years ago
Stephen Fromm
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.
12 years ago
Dag Wieers
2786149bdc
Moving now from getopt to optparse
...
Let me know if we can move to another library instead ;-)
12 years ago
Michael DeHaan
6d2f003ceb
Update formatter to not include orange blocks all over docsite page
12 years ago
Michael DeHaan
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
12 years ago
Marco Vito Moscaritolo
ee679c0190
Unified document generator and make to generate JSON and JS files
12 years ago
Dag Wieers
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...
12 years ago
Michael DeHaan
c3f443f56c
fix sorting
12 years ago
Michael DeHaan
761330b125
Fix module formatter indexing
12 years ago
Tim Bielawa
85fb7c6d4b
Library functions and modules should be in the 3 man page section. Also the files should end in '.3'
12 years ago
Michael DeHaan
31a4fe412f
Complain when modules do not have documentation.
12 years ago
Jan-Piet Mens
eb8a11237c
module_formatter can output lists of files to process (.rst and .tex)
12 years ago
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...
12 years ago
Marco Vito Moscaritolo
94de4db928
Add JSON output format to DOCUMENTS and EXAMPLES parser
12 years ago
Jan-Piet Mens
62d038dca4
module_formatter fixes
12 years ago
Michael DeHaan
0c855a85bc
fix module formatter output messages
12 years ago
Michael DeHaan
405c097c43
Various fixes for the module documentation auto-generator
12 years ago
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.
12 years ago
Jan-Piet Mens
d47e15a1f2
module_formatter in hacking/
12 years ago