ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Add note about how to submit doc changes to generated module docs, limit TOC depth for module category list.

Browse source
This commit is contained in:
Michael DeHaan 2013-12-25 21:29:54 -05:00
parent d6e28b4c57
commit 83d298accc
2 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docsite/_themes/srtd/footer.html
View file

@ -26,5 +26,6 @@
{%- endif %} {%- endif %}
</p> </p>
{% trans %}<a href="https://www.github.com/snide/sphinx_rtd_theme">Sphinx theme</a> provided by <a href="http://readthedocs.org">Read the Docs</a>{% endtrans %} Ansible docs are generated from <a href="http://github.com/ansible/ansible'>GitHub sources</A> using <A HREF="http://sphinx-doc.org/">Sphinx</A> using a theme provided by <a href="http://readthedocs.org">Read the Docs</a>. {% if pagename.endswith("_module") %}. Module documentation is not edited directly, but is generated from the source code for the modules. To submit an update to module docs, edit the 'DOCUMENTATION' metadata in the <A HREF="https://github.com/ansible/ansible/tree/devel/library">module source tree</A>. {% endif %}
</footer> </footer>

3
hacking/module_formatter.py
View file

@ -310,9 +310,10 @@ def main():
category_list_file.write("============\n") category_list_file.write("============\n")
category_list_file.write("\n\n") category_list_file.write("\n\n")
category_list_file.write(".. toctree::\n") category_list_file.write(".. toctree::\n")
category_list_file.write(" :maxdepth: 1\n\n")
for category in category_names: for category in category_names:
category_list_file.write(" list_of_%s_modules\n" % category) category_list_file.write(" list_of_%s_modules\n" % category)
process_category(category, categories, options, env, template, outputname) process_category(category, categories, options, env, template, outputname)
category_list_file.close() category_list_file.close()