cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Docsite formatting

Browse source
This commit is contained in:
Michael DeHaan 2014-09-26 18:23:57 -04:00
parent 7e520c4574
commit ffee9a8fe0
2 changed files with 21 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
hacking/module_formatter.py
View file

@ -210,8 +210,7 @@ def process_module(module, options, env, template, outputname, module_map):
if doc is None:
return "SKIPPED"
if "core" in module:
print "CORE"
if "/core/" in fname:
doc['core'] = True
else:
doc['core'] = False

31
hacking/templates/rst.j2
View file

@ -101,25 +101,34 @@ Examples
{% endfor %}
{% endif %}
Developers, Testers, and Bug Reporting
--------------------------------------
{% set repo = "https://github.com/ansible/ansible-modules-extras" %}
{% set tracker = "https://github.com/ansible/ansible-modules-extras/issues" %}
{% if core %}
{% set repo = "https://github.com/ansible/ansible-modules-core" %}
{% set tracker = "https://github.com/ansible/ansible-modules-core/issues" %}
{% endif %}
This is a Core Module
---------------------
This source of this module is hosted on GitHub in the `ansible-modules-core <http://github.com/ansible/ansible-modules-core>`_ repo.
This source of this module is hosted on GitHub in the `{{ repo }} <{{ repo }}>`_ repo.
If you believe you have found a bug in this module, and are already running the latest stable or development version of Ansbile, first look in the issue tracker at `{{ tracker }} <{{ tracker }}>`_ to see if a bug has already been filed. If not, we would be greatful if you would file one.
If you believe you have found a bug in this module, and are already running the latest stable or development version of Ansbile, first look in the `issue tracker at github.com/ansible/ansible-modules-core <http://github.com/ansible/ansible-modules-core>`_ to see if a bug has already been filed. If not, we would be greatful if you would file one.
Should you have a question rather than a bug report, inquries are welcome on the `ansible-project google group <https://groups.google.com/forum/#!forum/ansible-project>` or on Ansible's "#ansible" channel, located on irc.freenode.net. Development oriented topics should instead use the similar `ansible-devel google group <https://groups.google.com/forum/#!forum/ansible-project>`_.
Documentation updates for this module can also be edited directly by submitting a pull request to the module source code, just look for the "DOCUMENTATION" block in the source tree.
{% if not core %}
This is a "core" ansible module, which means it will recieve slightly higher priority for all requests than those in the "extras" repos.
{% else %}
This is an Extras Module
------------------------
This source of this module is hosted on GitHub in the `ansible-modules-extras <http://github.com/ansible/ansible-modules-extras>`_ repo.
If you believe you have found a bug in this module, and are already running the latest stable or development version of Ansbile, first look in the `issue tracker at github.com/ansible/ansible-modules-extras <http://github.com/ansible/ansible-modules-extras>`_ to see if a bug has already been filed. If not, we would be greatful if you would file one.
Should you have a question rather than a bug report, inquries are welcome on the `ansible-project google group <https://groups.google.com/forum/#!forum/ansible-project>` or on Ansible's "#ansible" channel, located on irc.freenode.net. Development oriented topics should instead use the similar `ansible-devel google group <https://groups.google.com/forum/#!forum/ansible-project>`_.
Documentation updates for this module can also be edited directly by submitting a pull request to the module source code, just look for the "DOCUMENTATION" block in the source tree.
Note that this module is designated a "extras" module. Non-core modules are still fully usuable, but may recieve slightly lower response rates for issues and pull requests.
Popular "extras" modules may be promoted to core modules over time.