1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Commit graph

73 commits

Author SHA1 Message Date
Brian Coca
ee08448b2e now module_formatter handles new expanded return values from the module_docs (still does not thing with new return value docs) 2015-02-19 18:07:05 -05:00
follower
a1c5294882 Fix misspelled "necessarily" 2014-11-29 14:55:25 +13:00
Brian Coca
339d1ccc8b fixed issue with subclasses across the repos clobbering each other, they
now merge
2014-11-04 20:54:55 -05:00
Brian Coca
2ba5c3c66b added blank line before section to avoid sphinx warnings 2014-11-04 18:14:30 -05:00
Michael DeHaan
c551fe8b50 Clarify module list footer. 2014-11-04 17:38:02 -05:00
Brian Coca
12393a4b47 subcategories are now Title case and _ gets changed to a space 2014-11-04 08:44:39 -05:00
Brian Coca
5f1ad79cd3 now correctly flags and sorts subcategory modules 2014-11-03 23:14:22 -05:00
Brian Coca
650048f7dd now displays subcategories correctly 2014-11-03 22:02:13 -05:00
Brian Coca
7bd2c945a7 now doc generation does not ignore subdirs of cloud 2014-11-03 08:15:26 -05:00
Brian Coca
80b1365d53 now correctly processes modules when in subdirs of cloud 2014-11-01 23:19:25 -04:00
Brian Coca
f6d9aa7a8f corrected text/flag 2014-10-31 16:05:22 -04:00
Brian Coca
023f5fd7e0 Added note explaning the module tagging 2014-10-31 15:06:00 -04:00
Brian Coca
44f0279d0a Now adds flags for non core and deprecated modules in listing 2014-10-31 14:20:26 -04:00
Brian Coca
8b5b97d066 now docs handle deprecated modules but still ignore aliases 2014-10-30 13:29:54 -04:00
Brian Coca
27d741102c Created Deprecated module category that only appears when there is
something to show
2014-10-30 11:26:43 -04:00
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
2014-10-28 08:36:31 -07:00
Michael DeHaan
ffee9a8fe0 Docsite formatting 2014-09-26 18:23:57 -04:00
Michael DeHaan
e8fe306cef Some various comments about the new repos, more to likely come. 2014-09-26 17:52:50 -04:00
Michael DeHaan
bceb0026a5 Updating the module formatter to deal with the new repo structure. 2014-09-26 17:10:13 -04:00
Michael DeHaan
dfd4f18095 Docsite things. 2014-06-19 14:25:28 -05:00
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.
2014-03-16 13:10:28 -04:00
Lukáš Lalinský
95d102f5e4 Remove obsolete module development docs 2014-02-22 15:51:59 +01:00
Michael DeHaan
c4a8a6d3c2 Add an "all" category so all modules show up uncategorized there. 2014-01-02 17:42:18 -05:00
Michael DeHaan
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
Mikhail Sobolev
7965d331f3 do not produce too deep toc for category lists 2013-12-25 21:19:00 +02:00
Mikhail Sobolev
af1f8db51d remove trailing whitespaces 2013-12-25 21:19:00 +02:00
Michael DeHaan
a5e8e10bb0 Removed unused things. 2013-12-25 14:17:47 -05:00
Michael DeHaan
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
Michael DeHaan
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
Michael DeHaan
31d0060de8 Standardized on yml suffix, so fix this example content filename. 2013-12-25 13:24:29 -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
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
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) 2013-11-27 21:14:38 -05:00
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.
2013-11-18 18:55:49 -05:00
Alan Fairless
af40b19a2d Fix format string typo 2013-10-31 12:34:51 -05:00
Michael DeHaan
5f18a53530 Fixup docs formatting. 2013-08-06 10:53:56 -04:00
Michael DeHaan
fa9635478b Fixing your YAML Seth :) 2013-07-15 13:16:37 -04:00
Michael DeHaan
3f8aa8aec5 Fix up some module docs formatting errors. 2013-06-19 22:37:09 -04:00
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.
2013-06-14 13:27:59 -05:00
Michael DeHaan
9ca0289dee Fixup the module formatter to explain the EXAMPLES string as well. 2013-05-11 16:32:22 -04:00
Michael DeHaan
627b6a0455 Have 1.2 clear in docs 2013-05-02 11:31:51 -04:00
Michael DeHaan
391fb98ee2 Allow modules to be categorized, and also sort them when generating the documentation. 2013-04-28 15:03:45 -04:00
Michael DeHaan
148d8859ba Docs on parameterized roles, make document generation output less noisy 2013-04-12 17:45:27 -04:00
Marco Vito Moscaritolo
a53259a797 Fixed option validation error
Fixed error on validation that block javascript documentation generation.
2013-03-29 16:30:33 +01:00
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.
2013-03-17 19:55:56 +02: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
Michael DeHaan
0ae7f996f5 Make sure all the lookup plugins are documented. 2013-02-02 11:51:25 -05:00
Michael DeHaan
dd5a8474f8 Have module formatter ignore more types of files. 2012-11-26 18:50:26 -05:00
Jan-Piet Mens
068ef0e979 module_formatter: re-instate code 2012-11-22 07:23:10 +01:00
Jan-Piet Mens
caf003c813 DOCUMENTATION strings 2012-11-21 18:49:30 +01:00