From 83d298accce9cbc8be1449558309322941556555 Mon Sep 17 00:00:00 2001 From: Michael DeHaan Date: Wed, 25 Dec 2013 21:29:54 -0500 Subject: [PATCH] Add note about how to submit doc changes to generated module docs, limit TOC depth for module category list. --- docsite/_themes/srtd/footer.html | 3 ++- hacking/module_formatter.py | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docsite/_themes/srtd/footer.html b/docsite/_themes/srtd/footer.html index e42d753ff6..684469cac1 100644 --- a/docsite/_themes/srtd/footer.html +++ b/docsite/_themes/srtd/footer.html @@ -26,5 +26,6 @@ {%- endif %}

- {% trans %}Sphinx theme provided by Read the Docs{% endtrans %} +Ansible docs are generated from Sphinx using a theme provided by Read the Docs. {% 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 module source tree. {% endif %} + diff --git a/hacking/module_formatter.py b/hacking/module_formatter.py index a6c0cf0eaf..237486db24 100755 --- a/hacking/module_formatter.py +++ b/hacking/module_formatter.py @@ -310,9 +310,10 @@ def main(): category_list_file.write("============\n") category_list_file.write("\n\n") category_list_file.write(".. toctree::\n") + category_list_file.write(" :maxdepth: 1\n\n") 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) category_list_file.close()