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
95d102f5
Commit
95d102f5
authored
Feb 22, 2014
by
Lukáš Lalinský
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Remove obsolete module development docs
parent
c7a30df5
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
1 additions
and
18 deletions
+1
-18
docsite/rst/developing_modules.rst
+0
-17
hacking/module_formatter.py
+1
-1
No files found.
docsite/rst/developing_modules.rst
View file @
95d102f5
...
...
@@ -416,23 +416,6 @@ Put your completed module file into the 'library' directory and then
run the command: ``make webdocs``. The new 'modules.html' file will be
built and appear in the 'docsite/' directory.
You can also test-build your docs one-by-one using the
``module_formatter.py`` script:
.. code-block:: bash
$ ./hacking/module_formatter.py -t man -M library/ -m git > ansible-git.1
$ man ./ansible-git.1
This will build a manpage for the git module, and look in the
'library/' directory for the module source. To see all the other
output formats available:
.. code-block:: bash
$ ./hacking/module_formatter.py -t --help
.. tip::
If you're having a problem with the syntax of your YAML you can
...
...
hacking/module_formatter.py
View file @
95d102f5
...
...
@@ -146,7 +146,7 @@ def generate_parser():
p
.
add_option
(
"-A"
,
"--ansible-version"
,
action
=
"store"
,
dest
=
"ansible_version"
,
default
=
"unknown"
,
help
=
"Ansible version number"
)
p
.
add_option
(
"-M"
,
"--module-dir"
,
action
=
"store"
,
dest
=
"module_dir"
,
default
=
MODULEDIR
,
help
=
"Ansible library path"
)
p
.
add_option
(
"-T"
,
"--template-dir"
,
action
=
"store"
,
dest
=
"template_dir"
,
default
=
"hacking/templates"
,
help
=
"directory containing Jinja2 templates"
)
p
.
add_option
(
"-t"
,
"--type"
,
action
=
'store'
,
dest
=
'type'
,
choices
=
[
'
html'
,
'latex'
,
'man'
,
'rst'
,
'json'
,
'markdown'
,
'js'
],
default
=
'latex
'
,
help
=
"Document type"
)
p
.
add_option
(
"-t"
,
"--type"
,
action
=
'store'
,
dest
=
'type'
,
choices
=
[
'
rst'
],
default
=
'rst
'
,
help
=
"Document type"
)
p
.
add_option
(
"-v"
,
"--verbose"
,
action
=
'store_true'
,
default
=
False
,
help
=
"Verbose"
)
p
.
add_option
(
"-o"
,
"--output-dir"
,
action
=
"store"
,
dest
=
"output_dir"
,
default
=
None
,
help
=
"Output directory for module files"
)
p
.
add_option
(
"-I"
,
"--includes-file"
,
action
=
"store"
,
dest
=
"includes_file"
,
default
=
None
,
help
=
"Create a file containing list of processed modules"
)
...
...
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