Commit Graph

140 Commits (21b4212ff554927948e8eb3588b4e8e00627be1c)

Author SHA1 Message Date
Michael DeHaan c4a8a6d3c2 Add an "all" category so all modules show up uncategorized there. 11 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
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 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 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 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 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
Jens Rantil 2096c669d9 `env-setup` fix for zsh <= 4.3.10
This fixes issue #5026. It used to work. The regression was
introduced in 2b3381de7c.
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
phy1729 2b3381de7c Add zsh support for working dir independant sourcing 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
jctanner b6c1574f5c Merge pull request #4765 from mvo5/bugfix/fix-man-template
Fixes in the man template
11 years ago
Michael Vogt b8e641136a make comment lines in troff start with .\" and add a .SH EXAMPLES to the PLAINEXAMPLES section 11 years ago
Michael DeHaan d34a26e307 Undo an inadvertant revert from template changes so we still allow pythonic imports in module land. 11 years ago
Alan Fairless af40b19a2d Fix format string typo 11 years ago
James Tanner d154bf8781 Revert templating enhancements from 73dbab70 e6c28658 d409352c 9858b1f2 4587528b 9b1fe455 214b0b05 8d3db803 7f9504d1 5031104c 35cb9dc2 2bd8cb57 1e85c754 11 years ago
Michael DeHaan 9858b1f2f3 Enable imports to work on a snippet based system, allowing for instance a library of common EC2 functions
to be reused between modules.  See library/system/service and library/system/ping for initial examples.  Can
work the old way to just import 'basic', or can import the new way to import multiple pieces of code from
module_utils/.
11 years ago
Jharrod LaFon 996f87d898 Fixed usage comment to fish syntax for sourcing a file 11 years ago
Jharrod LaFon d0fe447fd1 Fixed incorrectly set PYTHONPATH 11 years ago
Jharrod LaFon dbfcd78790 Added an env-setup file for Fish 11 years ago
Michael DeHaan 5f18a53530 Fixup docs formatting. 11 years ago
Michael DeHaan 303a8ff563 Fix module path in readme file. 11 years ago
Michael DeHaan fa9635478b Fixing your YAML Seth :) 11 years ago
Michael DeHaan 955611bda8 Fixes #3294 12 years ago
Michael DeHaan 8b592c9d4b Add some whitespace to script 12 years ago
martin f. krafft 3839dcd56c Remove extra $ character
Signed-off-by: martin f. krafft <madduck@madduck.net>
12 years ago
martin f. krafft bbbc214ffb Remove bashisms, replace with POSIX constructs
This replaces double conditional brackets with single ones and gets ris
of bashisms, so that the tool should be sourcable from any POSIX shell.

Constructs like [ $foo = "$bar"* ] yield filesystem-globbing behaviour
according to POSIX. A compliant way is to use case statements.

Signed-off-by: martin f. krafft <madduck@madduck.net>
12 years ago
martin f. krafft 9f4988dbfd Quote variables in shell script
In case paths contain spaces, it's better to consistently quote
variables, and to use $() instead of `` for external invocations.

Signed-off-by: martin f. krafft <madduck@madduck.net>
12 years ago
martin f. krafft 4b9f8fc294 Replace external command with shell construct
dirname/basename do not need an external process, shell variable
expansion can be made to do the same a bit faster.

Signed-off-by: martin f. krafft <madduck@madduck.net>
12 years ago
martin f. krafft 013cd38929 Remove shebang line
The env-setup script is not intended to be run directly, so it does not
need a shebang line, which might even create the wrong expectations.

Signed-off-by: martin f. krafft <madduck@madduck.net>
12 years ago
Michael DeHaan 3f8aa8aec5 Fix up some module docs formatting errors. 12 years ago
Michael DeHaan b72109a04b Merge pull request #3273 from jlund/ansiblecc-to-ansibleworkscom
Update all ansible.cc references in the documentation to point to ansibleworks.com
12 years ago
Michael DeHaan 4553b3d0cf Merge branch 'generalise-hacking-dir-path-discovery' of git://github.com/madduck/ansible into envsetup2 12 years ago
Joshua Lund 0f81d1630f * Updated all ansible.cc references in the documentation to point
to ansibleworks.com
* Fixed a few misspelled words
12 years ago
Michael DeHaan af9b510769 Merge pull request #3220 from dsedivec/devel
Improve Markdown (and other) module doc output
12 years ago
trbs a4223e119d fixed x-bits in git 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
martin f. krafft 3b008d6fa6 Expand usage synopsis
'source' is actually a "bashism" and the POSIX-way of sourcing a file
uses the single dot (which is arguably less readable). Both yield the
same result, and since the script may now also be sourced from
within the hacking directory, this commit expands the usage synopsis
accordingly.

Signed-off-by: martin f. krafft <madduck@madduck.net>

Conflicts:
	hacking/env-setup
12 years ago
martin f. krafft 581dea70d1 Generalise determination of hacking directory path
Bash needs a special case to determine the dirname of the sourced path
(the hacking dir), but in all other cases, using $0 allows the script to
be sourced also from within the hacking directory, not only from its
parent.

Signed-off-by: martin f. krafft <madduck@madduck.net>
12 years ago
Michael DeHaan 88102df07c Show 'yes' and 'no' in choices on docs page. 12 years ago
Nicolas Grilly 75ceb80572 Escape args injected in new style modules 12 years ago