Merge pull request #213 from whiteinge/doc-autosummary

Move modules/states/renderers/returners docs to autosummary
saltstack · Nov 13, 2011 · c0b7b9c · c0b7b9c
2 parents 800c7ff + c1bbe34
commit c0b7b9c
Show file tree

Hide file tree

Showing 79 changed files with 523 additions and 372 deletions.
diff --git a/doc/_templates/autosummary.rst.tmpl b/doc/_templates/autosummary.rst.tmpl
@@ -0,0 +1,6 @@
+{{ underline }}
+{{ fullname }}
+{{ underline }}
+
+.. automodule:: {{ fullname }}
+    :members:
diff --git a/doc/_templates/autosummarysidebar.html b/doc/_templates/autosummarysidebar.html
@@ -0,0 +1,8 @@
+{% if parents %}
+<h3>Parent topic</h3>
+<ul>
+    {% for p in parents %}
+    <li><a href="{{ p.link|e }}">{{ p.title }}</a></li>
+    {% endfor %}
+</ul>
+{% endif %}
diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html
@@ -40,19 +40,9 @@ <h3>{{ _('Navigation') }}</h3>
     <div class="sidebar">
         {%- block sidebarlogo %}{%- endblock %}
 
-        {%- if sidebars != None %}
-            {#- new style sidebar: explicitly include/exclude templates #}
-            {%- for sidebartemplate in sidebars %}
-                {%- include sidebartemplate %}
-            {%- endfor %}
-        {%- else %}
-            {#- old style sidebars: using blocks -- should be deprecated #}
-            {%- block sidebartoc %}{%- include "localtoc.html" %}{%- endblock %}
-            {%- block sidebarrel %}{%- include "relations.html" %}{%- endblock %}
-            {%- block sidebarsourcelink %}{%- include "sourcelink.html" %}{%- endblock %}
-            {%- if customsidebar %}{%- include customsidebar %}{%- endif %}
-            {%- block sidebarsearch %}{%- include "searchbox.html" %}{%- endblock %}
-        {%- endif %}
+        {%- for sidebartemplate in sidebars|default(html_default_sidebars, true) %}
+            {%- include sidebartemplate %}
+        {%- endfor %}
     </div>
     {%- endif %}
 {%- endmacro %}

diff --git a/doc/conf.py b/doc/conf.py
@@ -29,10 +29,12 @@
 templates_path = ['_templates']
 exclude_patterns = ['_build']
 
-extensions = ['saltdocs', 'sphinx.ext.autodoc', 'sphinx.ext.extlinks']
+extensions = ['saltdocs', 'sphinx.ext.autodoc', 'sphinx.ext.extlinks', 'sphinx.ext.autosummary']
 
 modindex_common_prefix = ['salt.']
 
+autosummary_generate = True
+
 # Define a substitution for linking to the latest release tarball
 rst_prolog = """\
 .. |latest| replace:: https://github.com/downloads/thatch45/salt/salt-%s.tar.gz
@@ -59,8 +61,20 @@
 html_use_smartypants = False
 
 html_additional_pages = {'index': 'index.html'}
-html_sidebars = {'index': ['indexsidebar.html']}
+
+html_default_sidebars = [
+    'localtoc.html',
+    'relations.html',
+    'sourcelink.html',
+    'searchbox.html']
+
+html_sidebars = {
+    'ref/**/all/salt.*': ['autosummarysidebar.html'] + html_default_sidebars,
+    'index': ['indexsidebar.html', 'searchbox.html'],
+}
+
 html_context = {
+    'html_default_sidebars': html_default_sidebars,
     'github_base': 'https://github.com/thatch45/salt',
     'github_issues': 'https://github.com/thatch45/salt/issues',
     'github_downloads': 'https://github.com/thatch45/salt/downloads',

diff --git a/doc/contents.rst b/doc/contents.rst
@@ -17,10 +17,14 @@ Full Table of Contents
 
     ref/index
     ref/modules/*
+    ref/modules/all/index
     ref/grains
     ref/returners/*
+    ref/returners/all/index
     ref/states/*
+    ref/states/all/index
     ref/renderers/*
+    ref/renderers/all/index
     ref/runners
     ref/peer
     ref/syndic

diff --git a/doc/home.rst b/doc/home.rst
@@ -36,19 +36,19 @@ get much more out of Salt.
 
 * **Remote execution:**
   :doc:`Writing modules <ref/modules/index>`
-  | :doc:`full list of modules <ref/modules/modules>`
+  | :doc:`full list of modules <ref/modules/all/index>`
 * **System info & detection:**
   :doc:`Grains <ref/grains>` 
 * **Displaying or storing responses:**
   :doc:`Writing returners <ref/returners/index>`
-  | :doc:`full list of returners <ref/returners/returners>`
+  | :doc:`full list of returners <ref/returners/all/index>`
 * **State enforcement:**
   :doc:`States <ref/states/index>`
   | :doc:`Highstate data structure <ref/states/highstate>`
-  | :doc:`full list of states <ref/states/states>`
+  | :doc:`full list of states <ref/states/all/index>`
 * **Renderers:**
   :doc:`Renderers <ref/renderers/index>`
-  | :doc:`full list of renderers <ref/renderers/renderers>`
+  | :doc:`full list of renderers <ref/renderers/all/index>`
 * **Transferring & syncing files:**
   :doc:`File Server <ref/file_server/index>`
 * **Network topology:**

diff --git a/doc/ref/modules/all/index.rst b/doc/ref/modules/all/index.rst
@@ -0,0 +1,49 @@
+.. _all-salt.modules:
+
+============================
+Full list of builtin modules
+============================
+
+.. currentmodule:: salt.modules
+
+.. autosummary::
+    :toctree:
+    :template: autosummary.rst.tmpl
+
+    apache
+    apt
+    butterkvm
+    cluster
+    cmd
+    cp
+    cron
+    disk
+    file
+    freebsdpkg
+    grains
+    groupadd
+    hosts
+    kmod
+    linux_sysctl
+    mdadm
+    moosefs
+    mount
+    mysql
+    network
+    pacman
+    ps
+    publish
+    puppet
+    pw_group
+    pw_user
+    selinux
+    service
+    shadow
+    solr
+    ssh
+    state
+    status
+    test
+    useradd
+    virt
+    yum
diff --git a/doc/ref/modules/all/salt.modules.apache.rst b/doc/ref/modules/all/salt.modules.apache.rst
@@ -0,0 +1,6 @@
+===================
+salt.modules.apache
+===================
+
+.. automodule:: salt.modules.apache
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.apt.rst b/doc/ref/modules/all/salt.modules.apt.rst
@@ -0,0 +1,6 @@
+================
+salt.modules.apt
+================
+
+.. automodule:: salt.modules.apt
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.butterkvm.rst b/doc/ref/modules/all/salt.modules.butterkvm.rst
@@ -0,0 +1,6 @@
+======================
+salt.modules.butterkvm
+======================
+
+.. automodule:: salt.modules.butterkvm
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.cluster.rst b/doc/ref/modules/all/salt.modules.cluster.rst
@@ -0,0 +1,6 @@
+====================
+salt.modules.cluster
+====================
+
+.. automodule:: salt.modules.cluster
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.cmd.rst b/doc/ref/modules/all/salt.modules.cmd.rst
@@ -0,0 +1,6 @@
+================
+salt.modules.cmd
+================
+
+.. automodule:: salt.modules.cmd
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.cp.rst b/doc/ref/modules/all/salt.modules.cp.rst
@@ -0,0 +1,6 @@
+===============
+salt.modules.cp
+===============
+
+.. automodule:: salt.modules.cp
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.cron.rst b/doc/ref/modules/all/salt.modules.cron.rst
@@ -0,0 +1,6 @@
+=================
+salt.modules.cron
+=================
+
+.. automodule:: salt.modules.cron
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.disk.rst b/doc/ref/modules/all/salt.modules.disk.rst
@@ -0,0 +1,6 @@
+=================
+salt.modules.disk
+=================
+
+.. automodule:: salt.modules.disk
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.file.rst b/doc/ref/modules/all/salt.modules.file.rst
@@ -0,0 +1,6 @@
+=================
+salt.modules.file
+=================
+
+.. automodule:: salt.modules.file
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.freebsdpkg.rst b/doc/ref/modules/all/salt.modules.freebsdpkg.rst
@@ -0,0 +1,6 @@
+=======================
+salt.modules.freebsdpkg
+=======================
+
+.. automodule:: salt.modules.freebsdpkg
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.grains.rst b/doc/ref/modules/all/salt.modules.grains.rst
@@ -0,0 +1,6 @@
+===================
+salt.modules.grains
+===================
+
+.. automodule:: salt.modules.grains
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.groupadd.rst b/doc/ref/modules/all/salt.modules.groupadd.rst
@@ -0,0 +1,6 @@
+=====================
+salt.modules.groupadd
+=====================
+
+.. automodule:: salt.modules.groupadd
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.hosts.rst b/doc/ref/modules/all/salt.modules.hosts.rst
@@ -0,0 +1,6 @@
+==================
+salt.modules.hosts
+==================
+
+.. automodule:: salt.modules.hosts
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.kmod.rst b/doc/ref/modules/all/salt.modules.kmod.rst
@@ -0,0 +1,6 @@
+=================
+salt.modules.kmod
+=================
+
+.. automodule:: salt.modules.kmod
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.linux_sysctl.rst b/doc/ref/modules/all/salt.modules.linux_sysctl.rst
@@ -0,0 +1,6 @@
+=========================
+salt.modules.linux_sysctl
+=========================
+
+.. automodule:: salt.modules.linux_sysctl
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.mdadm.rst b/doc/ref/modules/all/salt.modules.mdadm.rst
@@ -0,0 +1,6 @@
+==================
+salt.modules.mdadm
+==================
+
+.. automodule:: salt.modules.mdadm
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.moosefs.rst b/doc/ref/modules/all/salt.modules.moosefs.rst
@@ -0,0 +1,6 @@
+====================
+salt.modules.moosefs
+====================
+
+.. automodule:: salt.modules.moosefs
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.mount.rst b/doc/ref/modules/all/salt.modules.mount.rst
@@ -0,0 +1,6 @@
+==================
+salt.modules.mount
+==================
+
+.. automodule:: salt.modules.mount
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.mysql.rst b/doc/ref/modules/all/salt.modules.mysql.rst
@@ -0,0 +1,6 @@
+==================
+salt.modules.mysql
+==================
+
+.. automodule:: salt.modules.mysql
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.network.rst b/doc/ref/modules/all/salt.modules.network.rst
@@ -0,0 +1,6 @@
+====================
+salt.modules.network
+====================
+
+.. automodule:: salt.modules.network
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.pacman.rst b/doc/ref/modules/all/salt.modules.pacman.rst
@@ -0,0 +1,6 @@
+===================
+salt.modules.pacman
+===================
+
+.. automodule:: salt.modules.pacman
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.ps.rst b/doc/ref/modules/all/salt.modules.ps.rst
@@ -0,0 +1,6 @@
+===============
+salt.modules.ps
+===============
+
+.. automodule:: salt.modules.ps
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.publish.rst b/doc/ref/modules/all/salt.modules.publish.rst
@@ -0,0 +1,6 @@
+====================
+salt.modules.publish
+====================
+
+.. automodule:: salt.modules.publish
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.puppet.rst b/doc/ref/modules/all/salt.modules.puppet.rst
@@ -0,0 +1,6 @@
+===================
+salt.modules.puppet
+===================
+
+.. automodule:: salt.modules.puppet
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.pw_group.rst b/doc/ref/modules/all/salt.modules.pw_group.rst
@@ -0,0 +1,6 @@
+=====================
+salt.modules.pw_group
+=====================
+
+.. automodule:: salt.modules.pw_group
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.pw_user.rst b/doc/ref/modules/all/salt.modules.pw_user.rst
@@ -0,0 +1,6 @@
+====================
+salt.modules.pw_user
+====================
+
+.. automodule:: salt.modules.pw_user
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.selinux.rst b/doc/ref/modules/all/salt.modules.selinux.rst
@@ -0,0 +1,6 @@
+====================
+salt.modules.selinux
+====================
+
+.. automodule:: salt.modules.selinux
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.service.rst b/doc/ref/modules/all/salt.modules.service.rst
@@ -0,0 +1,6 @@
+====================
+salt.modules.service
+====================
+
+.. automodule:: salt.modules.service
+    :members:
diff --git a/doc/ref/modules/all/salt.modules.shadow.rst b/doc/ref/modules/all/salt.modules.shadow.rst
@@ -0,0 +1,6 @@
+===================
+salt.modules.shadow
+===================
+
+.. automodule:: salt.modules.shadow
+    :members: