Commit Graph

97 Commits (186fbd7645ba495e2b276afc80fc3904b76dd6c4)

Author SHA1 Message Date
Toshio Kuratomi 4ed88512e4 Move uses of to_bytes, to_text, to_native to use the module_utils version (#17423)
We couldn't copy to_unicode, to_bytes, to_str into module_utils because
of licensing.  So once created it we had two sets of functions that did
the same things but had different implementations.  To remedy that, this
change removes the ansible.utils.unicode versions of those functions.
8 years ago
Matt Davis ec2cb07988 Make 'required' optional in module docs (#15906)
Updated module dev docs, doc build, ansible-doc to match
9 years ago
Brian Coca 478674cc57 typo fix 9 years ago
Brian Coca b7c874f81a enforce required 'required' in docs 9 years ago
Toshio Kuratomi b27c424fa1 Fixes to the documentation build (#15356)
* Could only have one alias before.  Subsequent aliases overrode the
  previous ones.  Now multiple aliases work.
* Fix BLACKLISTED_MODULES.   Previously, modules were listed in the
  generated documentation despite being blacklisted
* Deprecated modules form extras were showing the (E) tag and not the
  (D) tag. Reversed that now (Probably not necessary to also show the
  E tag).
* Sort the deprecated modules alphabetically in the Category docs as
  well as the list of all modules
* Optimization: Previously rendered the modules to rst twice once in all
  group and once in individual categories.  Fixed to only render them
  once.
* Add fireball to blacklist and remove async_status (as people need to
  use that).
9 years ago
Brian Coca 6414c967e4 now check for description and listify if needed
fixes #14371
9 years ago
Toshio Kuratomi 5cd3f71792 Handle utf-8 in module short desc 9 years ago
Jeremy Audet 5cac8efd73 Make "make webdocs" compatible with Python 3
The `webdocs` make target fails under Python 3. It fails due to a variety of
syntax errors, such as the use of `except Foo, e` and `print 'foo'`. Fix #13463
by making code compatible with both Python 2 and 3.
9 years ago
Brian Coca 5719912e7f added a skip for the test dir in module repos 9 years ago
Brian Coca 3a0bf55ae3 better error catching for doc build 9 years ago
Marius Gedminas 823677b490 Replace .iteritems() with six.iteritems()
Replace .iteritems() with six.iteritems() everywhere except in
module_utils (because there's no 'six' on the remote host).  And except
in lib/ansible/galaxy/data/metadata_template.j2, because I'm not sure
six is available there.
9 years ago
Kevin Houdebert b8c9391d0c Change to python3 syntax 9 years ago
Brian Coca f5c8055879 removed debug stuff 9 years ago
Brian Coca a78fdde32c better handling for weird doc corner cases (abscense of options, bad text objects, etc)
also updated extras to get some docfixes on the module side
9 years ago
Brian Coca 740f15cb0d just remove version_added when to old, not the whole option! 9 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
9 years ago
Brian Coca 811b10d132 docs will not mention versions older than 1.5 9 years ago
James Cammarata 2bad888f28 Merge branch 'v2_final' into devel_switch_v2
Conflicts:
	lib/ansible/inventory/__init__.py
	lib/ansible/modules/core
	lib/ansible/utils/__init__.py
	lib/ansible/utils/module_docs.py
10 years ago
Florian Apolloner 3010190592 Fixing up the hacking module_formatter code for v2 10 years ago
Toshio Kuratomi 4c8d27f7bb Make module formatting into links to the other module docs 10 years ago
Brian Coca c3076b8478 added module returnval documentation to web docs 10 years ago
Brian Coca 94909bd4a2 Added return values documentation to modules 10 years ago
Brian Coca 68a06e542d Merge pull request #9666 from follower/patch-8
Correct typo of "actively" (Attempt #2)
10 years ago
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 8b278fee51 Correct typo of "actively" (Attempt #2) 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