saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Customized the default table of contents to show more information

Browse source 
Brought a little more organization to the list of modules and returners
pages.
This commit is contained in:
Seth House 2011-06-25 01:34:33 -06:00
parent 726c318218
commit 5d167c2b7b
5 changed files with 45 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
doc/index.rst
View file

@ -64,16 +64,29 @@ Extending Salt
Writing your own customizations on top of Salt
.. toctree::
:maxdepth: 1
:hidden:
ref/index
ref/python-api
ref/modules/index
ref/returners/index
ref/grains
ref/renderers
ref/returners/index
ref/states
ref/renderers
ref/python-api
* **Modules:**
:doc:`Writing modules <ref/modules/index>`
| :doc:`full list of modules <ref/modules/modules>`
* **Grains:**
:doc:`Grains <ref/grains>`
* **Returners:**
:doc:`Writing returners <ref/returners/index>`
| :doc:`full list of returners <ref/returners/returners>`
* **State enforcement:**
:doc:`States <ref/states>`
| :doc:`Renderers <ref/renderers>`
* **Python API:**
:doc:`Python API <ref/python-api>`
Getting involved
================

9
doc/ref/modules/index.rst
View file

@ -4,15 +4,16 @@ Modules
Salt modules are the functions called by the :command:`salt` command.
Full list of builtin modules
============================
.. toctree::
:maxdepth: 1
:hidden:
:glob:
*
.. seealso:: :doc:`Full list of builtin modules <modules>`
Salt ships with many modules that cover a wide variety of tasks.
Easy Modules to write
=====================

23
doc/ref/modules/modules.rst
View file

@ -1,102 +1,95 @@
=============================
============================
Full list of builtin modules
============================
.. contents:: Contents
:local:
:depth: 1
:mod:`salt.modules.butterkvm`
=============================
.. automodule:: salt.modules.butterkvm
:members:
===========================
:mod:`salt.modules.cluster`
===========================
.. automodule:: salt.modules.cluster
:members:
=======================
:mod:`salt.modules.cmd`
=======================
.. automodule:: salt.modules.cmd
:members:
======================
:mod:`salt.modules.cp`
======================
.. automodule:: salt.modules.cp
:members:
========================
:mod:`salt.modules.disk`
========================
.. automodule:: salt.modules.disk
:members:
==========================
:mod:`salt.modules.grains`
==========================
.. automodule:: salt.modules.grains
:members:
===========================
:mod:`salt.modules.network`
===========================
.. automodule:: salt.modules.network
:members:
==========================
:mod:`salt.modules.pacman`
==========================
.. automodule:: salt.modules.pacman
:members:
===========================
:mod:`salt.modules.service`
===========================
.. automodule:: salt.modules.service
:members:
=========================
:mod:`salt.modules.state`
=========================
.. automodule:: salt.modules.state
:members:
==========================
:mod:`salt.modules.status`
==========================
.. automodule:: salt.modules.status
:members:
==========================
:mod:`salt.modules.sysctl`
==========================
.. automodule:: salt.modules.sysctl
:members:
========================
:mod:`salt.modules.test`
========================
.. automodule:: salt.modules.test
:members:
========================
:mod:`salt.modules.virt`
========================
.. automodule:: salt.modules.virt
:members:
=======================
:mod:`salt.modules.yum`
=======================

15
doc/ref/returners/index.rst
View file

@ -2,6 +2,12 @@
Returners
=========
.. toctree::
:hidden:
:glob:
*
By default the return values of the commands sent to the salt minions are
returned to the salt-master. But since the commands executed on the salt
minions are detatched from the call on the salt master, there is no need for
@ -14,14 +20,7 @@ The returner interface allows the return data to be sent to any system that
can recieve data. This means that return data can be sent to a Redis server,
a MongoDB server, a MySQL server, or any system!
Full list of builtin returners
==============================
.. toctree::
:maxdepth: 1
:glob:
*
.. seealso:: :doc:`Full list of builtin returners <returners>`
Writing a Returner
==================

10
doc/ref/returners/returners.rst
View file

@ -1,11 +1,17 @@
===========================
==============================
Full list of builtin returners
==============================
.. contents:: Contents
:local:
:depth: 1
:mod:`salt.returners.local`
===========================
.. automodule:: salt.returners.local
:members:
===========================
:mod:`salt.returners.redis`
===========================