Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
A
ansible
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
OpenEdx
ansible
Commits
0748e86f
Commit
0748e86f
authored
May 11, 2013
by
Michael DeHaan
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Fix documentation about examples in modules so folks use the new style.
parent
cdda88fd
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
3 additions
and
12 deletions
+3
-12
docsite/latest/rst/moduledev.rst
+3
-8
examples/DOCUMENTATION.yaml
+0
-4
No files found.
docsite/latest/rst/moduledev.rst
View file @
0748e86f
...
@@ -353,15 +353,10 @@ syntax highlighting before you include it in your Python file.
...
@@ -353,15 +353,10 @@ syntax highlighting before you include it in your Python file.
Example
Example
+++++++
+++++++
Here's a correctly formatted YAML document we could use for a
To print a basic documentation string, run ``./hacking/module_formatter.py -G``.
``DOCUMENTATION`` string:
.. literalinclude:: ../../examples/DOCUMENTATION.yaml
You can copy it into your module and use it as a starting point
when writing your own docs.
This is available in the 'examples/' directory of the of the Ansible
github repository, and you can have that generated with
``./hacking/module_formatter.py -G``. You can copy it into your module and use
it as a starting point when writing your own docs.
Include it in your module file like this::
Include it in your module file like this::
...
...
examples/DOCUMENTATION.yaml
View file @
0748e86f
...
@@ -27,7 +27,3 @@ options:
...
@@ -27,7 +27,3 @@ options:
choices
:
[
list
,
of
,
choices
]
choices
:
[
list
,
of
,
choices
]
aliases
:
[
list
,
of
,
aliases
]
aliases
:
[
list
,
of
,
aliases
]
version_added
:
0.X
version_added
:
0.X
examples
:
# One or more of the following:
-
code
:
modulename opt1=arg1 opt2=arg2
description
:
Optional words describing this example
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment