80 Commits (dfec69b9a1039eb5670db2f86808e58258e23057)

Author	SHA1	Message	Date
Brian Coca	b606bcec04	Doc directives (#22524) ... * draft docs for directives * updated to document directives	8 years ago
Toshio Kuratomi	eb1214baad	New metadata 1.0 (#22587) ... Changes to the metadata format were approved here: https://github.com/ansible/proposals/issues/54 * Update documentation to the new metadata format * Changes to metadata-tool to account for new metadata * Add GPL license header * Add upgrade subcommand to upgrade metadata version * Change default metadata to the new format * Fix exclusion of non-modules from the metadata report * Fix ansible-doc for new module metadata * Exclude metadata version from ansible-doc output * Fix website docs generation for the new metadata * Update metadata schema in valiate-modules test * Update the metadata in all modules to the new version	8 years ago
John R Barker	04e816e13b	Stricter module documentation validation (#22353) ... Raise the bar for module `DOCUMENTAION` This validator update was used to find the issues in https://github.com/ansible/ansible/pull/22297/files **Validation** * Updated Validation and docs to enforce more (items fixed in https://github.com/ansible/ansible/pull/22297/files) * Use `suboptions` to document complex options * Validate module name * Validate deprecated modules have correct ANSIBLE_METADATA **Module Documentation Generation** * Document `suboptions:` Example https://gist.github.com/gundalow/4bdc3669d696268328ccc18528cc6718 * Tidy up HTML generation (valid HTML, no empty lists, etc) **Documentation** * Clarify the steps for deprecating a module * Use correct RST headings * Document `suboptions:` (options) * Document `contains:` (returns) **Details** The aim is to get this (and corresponding module updates) complete by the time `devel` becomes `2.4`, as this allows us to raise the bar for new modules Example `suboptions` https://gist.github.com/gundalow/4bdc3669d696268328ccc18528cc6718 The aim is to get this PR integrated into `devel` *before* we branch `stable-2.3`, this will allows us to: * Raise the bar for new modules in 2.4 * Ensure the generated module documentation for 2.3 and higher is improved, important as we will be doing versioned docs moving forward.	8 years ago
Brian Coca	b714f1fc4b	made module notes render nicer on docsite	8 years ago
Adam Johnson	fbfe66967d	Doc module meta grammar fixes (#20446) ... * Remove unnecessary 'the' * End sentences with a period	8 years ago
Brian Coca	3c4afd0470	Doc module meta (#20093) ... * updated module docs to reflect unification/meta * new doc page * also remove module refs to old core/extra * Update modules_support.rst Light edit.	8 years ago
Brian Coca	d138132bc2	show status/support in toc	8 years ago
Toshio Kuratomi	08d6990e67	Fix code-blocks to use correct syntax highlighting	8 years ago
Brian Coca	f5c1aefca9	added symbol conversion to deprecated ... fixes #19697	8 years ago
Brian Coca	0f4ca877ac	many doc fixes ... removed a bunch of warnings made nicer formatting of new module info	8 years ago
Sam Doran	73fc4e42f1	Correct type-o on support statement	8 years ago
Matt Davis	0b47c908eb	quick and dirty module doc updates (#18944) ... clean up core/extras, plumb in basic metadata display	8 years ago
Toshio Kuratomi	b8321c74c8	Fix indentation of multiline descriptions	8 years ago
Brian Coca	c16a88cac4	keep list as list in synopsis	8 years ago
Brian Coca	e1faa78722	fixed typo	9 years ago
Brian Coca	a3489408a5	fixes to playbooks_directives generation ... order is now predictable now correctly substitutes loop for with_ adds local_action to action	9 years ago
Brian Coca	3e28ee0fd4	avoid printing internal loop and loop_args	9 years ago
Brian Coca	fbdcb22e36	now generate list of playbook ojbect directives ... TODO: needs links/info and conditionals added	9 years ago
Brian Coca	fe09f7ee49	clarify that requirements are on host that runs it ... fixes http://github.com/ansible/ansible-modules-core/issues/3061	9 years ago
Brian Coca	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	10 years ago
Brian Coca	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	10 years ago
Brian Coca	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	10 years ago
Michael Scherer	85aa984340	Fix error in the column name in the doc	10 years ago
Brian Coca	b6ec502983	added missing element to make google groups link a actual link	10 years ago
Ján Dzurek	cf6155f1c2	rst.j2 template better core module source wording	10 years ago
Brian Coca	c3076b8478	added module returnval documentation to web docs	10 years ago
Brian Coca	2cacac4b23	minor adjustments to formatting	10 years ago
Brian Coca	94909bd4a2	Added return values documentation to modules	10 years ago
Alexey Shamrin	b950a38e30	fix links to ansible-devel in documentation pages	10 years ago
Brian Coca	650048f7dd	now displays subcategories correctly	10 years ago
Brian Coca	86de59235f	bypass core/extras text when module is deprecated	10 years ago
Brian Coca	8b5b97d066	now docs handle deprecated modules but still ignore aliases	10 years ago
Toshio Kuratomi	1e12d3028c	Merge pull request #9384 from insaneirish/devel ... Change "usuable" to "usable".	10 years ago
insaneirish	3d257bc695	Change "usuable" to "usable".	10 years ago
Igor Vuk	e19f3f8a5c	Typo: greatful -> grateful	10 years ago
Baptiste Mathus	2845f0c455	Typo: recieve -> receive.	10 years ago
Michael DeHaan	2211ae113c	Update rst.j2 ... typo fix	10 years ago
Martin Ueding	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.	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	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.	10 years ago
Michael DeHaan	2f811c40d7	Basic docsite formatting fixups	11 years ago
Mikhail Sobolev	84948292f3	include short_description in the module page's title	11 years ago
Mikhail Sobolev	fce90e0370	use rst formatting for sphinx part	11 years ago
Mikhail Sobolev	1713013dba	provide sections and local TOC for module documentation	11 years ago
Mikhail Sobolev	af1f8db51d	remove trailing whitespaces	11 years ago
Michael DeHaan	a5e8e10bb0	Removed unused things.	11 years ago
Michael DeHaan	f4aa6c53bd	Format module requirements as notes in Sphinx	11 years ago
Michael DeHaan	eb0509fce7	Update the styling for the module pages slightly.	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