Brian Coca
ee08448b2e
now module_formatter handles new expanded return values from the module_docs (still does not thing with new return value docs)
10 years ago
follower
a1c5294882
Fix misspelled "necessarily"
10 years ago
Brian Coca
339d1ccc8b
fixed issue with subclasses across the repos clobbering each other, they
...
now merge
10 years ago
Brian Coca
2ba5c3c66b
added blank line before section to avoid sphinx warnings
10 years ago
Michael DeHaan
c551fe8b50
Clarify module list footer.
10 years ago
Brian Coca
12393a4b47
subcategories are now Title case and _ gets changed to a space
10 years ago
Brian Coca
5f1ad79cd3
now correctly flags and sorts subcategory modules
10 years ago
Brian Coca
650048f7dd
now displays subcategories correctly
10 years ago
Brian Coca
7bd2c945a7
now doc generation does not ignore subdirs of cloud
10 years ago
Brian Coca
80b1365d53
now correctly processes modules when in subdirs of cloud
10 years ago
Brian Coca
f6d9aa7a8f
corrected text/flag
10 years ago
Brian Coca
023f5fd7e0
Added note explaning the module tagging
10 years ago
Brian Coca
44f0279d0a
Now adds flags for non core and deprecated modules in listing
10 years ago
Brian Coca
8b5b97d066
now docs handle deprecated modules but still ignore aliases
10 years ago
Brian Coca
27d741102c
Created Deprecated module category that only appears when there is
...
something to show
10 years ago
Brian Coca
5ab4467708
module formatter skips modules with leading underscore to avoid
...
documenting them. Soon will be patched to recognize them as either
deprecated or an alias
10 years ago
Michael DeHaan
ffee9a8fe0
Docsite formatting
10 years ago
Michael DeHaan
e8fe306cef
Some various comments about the new repos, more to likely come.
10 years ago
Michael DeHaan
bceb0026a5
Updating the module formatter to deal with the new repo structure.
10 years ago
Michael DeHaan
dfd4f18095
Docsite things.
11 years ago
Cristian Ciupitu
0749112286
Micro-optimization: replace s.find(x)!=-1 with x in s
...
timeit shows a speedup of ~3x on Python 2.7.5 x86_64.
It also makes the code a bit shorter.
11 years ago
Lukáš Lalinský
95d102f5e4
Remove obsolete module development docs
11 years ago
Michael DeHaan
c4a8a6d3c2
Add an "all" category so all modules show up uncategorized there.
11 years ago
Michael DeHaan
83d298accc
Add note about how to submit doc changes to generated module docs, limit TOC depth for module category list.
11 years ago
Mikhail Sobolev
7965d331f3
do not produce too deep toc for category lists
11 years ago
Mikhail Sobolev
af1f8db51d
remove trailing whitespaces
11 years ago
Michael DeHaan
a5e8e10bb0
Removed unused things.
11 years ago
Michael DeHaan
35ec9f81ae
Further modifications to the module formatter to adjust to the new theme, and some misc docs text corrections.
11 years ago
Michael DeHaan
fe2d00d9d3
WIP on refactoring the module formatter code that we use to build the doc site with.
11 years ago
Michael DeHaan
31d0060de8
Standardized on yml suffix, so fix this example content filename.
11 years ago
Michael DeHaan
10009b0d3f
Starting to refactor module formatter script.
...
Rename "jpfunc" to something more explanatory
11 years ago
Michael DeHaan
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.
11 years ago
Michael DeHaan
51e6f411f2
Docs: Fix the module formatter code that is intended to remove the 'historical' variable from showing up in version_added information (RST)
11 years ago
Michael DeHaan
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.
11 years ago
Alan Fairless
af40b19a2d
Fix format string typo
11 years ago
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