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

Replace manual & monolithic automodule with individual autosummary

Browse source
This commit is contained in:
Seth House 2011-11-07 00:47:06 -07:00
parent 800c7ffffe
commit 0639489083
12 changed files with 122 additions and 337 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/_templates/autosummary.rst.tmpl vendored Normal file
View file

@ -0,0 +1,6 @@
{{ underline }}
{{ fullname }}
{{ underline }}
.. automodule:: {{ fullname }}
:members:

4
doc/conf.py
View file

@ -29,10 +29,12 @@ master_doc = 'contents'
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

4
doc/contents.rst
View file

@ -17,10 +17,14 @@ Full Table of Contents
ref/index
ref/modules/*
ref/modules/all/*
ref/grains
ref/returners/*
ref/returners/all/*
ref/states/*
ref/states/all/*
ref/renderers/*
ref/renderers/all/*
ref/runners
ref/peer
ref/syndic

8
doc/home.rst
View file

@ -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:**

49
doc/ref/modules/all/index.rst Normal file
View file

@ -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

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

@ -1,226 +0,0 @@
============================
Full list of builtin modules
============================
:mod:`salt.modules.apache`
==========================
.. automodule:: salt.modules.apache
:members:
:mod:`salt.modules.apt`
=======================
.. automodule:: salt.modules.apt
:members:
: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.cron`
========================
.. automodule:: salt.modules.cron
:members:
..
:mod:`salt.modules.cytest`
==========================
..
.. automodule:: salt.modules.cytest
:members:
:mod:`salt.modules.disk`
========================
.. automodule:: salt.modules.disk
:members:
:mod:`salt.modules.file`
========================
.. automodule:: salt.modules.file
:members:
:mod:`salt.modules.freebsdpkg`
==============================
.. automodule:: salt.modules.freebsdpkg
:members:
:mod:`salt.modules.grains`
==========================
.. automodule:: salt.modules.grains
:members:
:mod:`salt.modules.groupadd`
============================
.. automodule:: salt.modules.groupadd
:members:
:mod:`salt.modules.hosts`
=========================
.. automodule:: salt.modules.hosts
:members:
:mod:`salt.modules.kmod`
========================
.. automodule:: salt.modules.kmod
:members:
:mod:`salt.modules.mdadm`
=========================
.. automodule:: salt.modules.mdadm
:members:
:mod:`salt.modules.moosefs`
===========================
.. automodule:: salt.modules.moosefs
:members:
:mod:`salt.modules.mount`
=========================
.. automodule:: salt.modules.mount
:members:
:mod:`salt.modules.mysql`
=========================
.. automodule:: salt.modules.mysql
:members:
:mod:`salt.modules.network`
===========================
.. automodule:: salt.modules.network
:members:
:mod:`salt.modules.pacman`
==========================
.. automodule:: salt.modules.pacman
:members:
:mod:`salt.modules.ps`
======================
.. automodule:: salt.modules.ps
:members:
:mod:`salt.modules.publish`
===========================
.. automodule:: salt.modules.publish
:members:
:mod:`salt.modules.puppet`
==========================
.. automodule:: salt.modules.puppet
:members:
:mod:`salt.modules.pw_group`
============================
.. automodule:: salt.modules.pw_group
:members:
:mod:`salt.modules.pw_user`
===========================
.. automodule:: salt.modules.pw_user
:members:
:mod:`salt.modules.selinux`
===========================
.. automodule:: salt.modules.selinux
:members:
:mod:`salt.modules.service`
===========================
.. automodule:: salt.modules.service
:members:
:mod:`salt.modules.shadow`
==========================
.. automodule:: salt.modules.shadow
:members:
:mod:`salt.modules.solr`
========================
.. automodule:: salt.modules.solr
:members:
:mod:`salt.modules.ssh`
=======================
.. automodule:: salt.modules.ssh
:members:
:mod:`salt.modules.state`
=========================
.. automodule:: salt.modules.state
:members:
:mod:`salt.modules.status`
==========================
.. automodule:: salt.modules.status
:members:
:mod:`salt.modules.test`
========================
.. automodule:: salt.modules.test
:members:
:mod:`salt.modules.useradd`
===========================
.. automodule:: salt.modules.useradd
:members:
:mod:`salt.modules.virt`
========================
.. automodule:: salt.modules.virt
:members:
:mod:`salt.modules.yum`
=======================
.. automodule:: salt.modules.yum
:members:

17
doc/ref/renderers/all/index.rst Normal file
View file

@ -0,0 +1,17 @@
.. _all-salt.renderers:
==============================
Full list of builtin renderers
==============================
.. currentmodule:: salt.renderers
.. autosummary::
:toctree:
:template: autosummary.rst.tmpl
json_jinja
json_mako
yaml_jinja
yaml_mako
py

18
doc/ref/renderers/renderers.rst
View file

@ -1,18 +0,0 @@
==============================
Full list of builtin renderers
==============================
.. automodule:: salt.renderers.json_jinja
:members:
.. automodule:: salt.renderers.json_mako
:members:
.. automodule:: salt.renderers.py
:members:
.. automodule:: salt.renderers.yaml_jinja
:members:
.. automodule:: salt.renderers.yaml_mako
:members:

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

@ -0,0 +1,15 @@
.. _all-salt.returners:
==============================
Full list of builtin returners
==============================
.. currentmodule:: salt.returners
.. autosummary::
:toctree:
:template: autosummary.rst.tmpl
local
mongo_return
redis_return

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

@ -1,25 +0,0 @@
==============================
Full list of builtin returners
==============================
.. contents:: Contents
:local:
:depth: 1
:mod:`salt.returners.local`
===========================
.. automodule:: salt.returners.local
:members:
:mod:`salt.returners.redis_return`
==================================
.. automodule:: salt.returners.redis_return
:members:
:mod:`salt.returners.mongo_return`
==================================
.. automodule:: salt.returners.mongo_return
:members:

24
doc/ref/states/all/index.rst Normal file
View file

@ -0,0 +1,24 @@
.. _all-salt.states:
===========================
Full list of builtin states
===========================
.. currentmodule:: salt.states
.. autosummary::
:toctree:
:template: autosummary.rst.tmpl
cmd
cron
file
group
host
kmod
mount
pkg
service
ssh_auth
sysctl
user

63
doc/ref/states/states.rst
View file

@ -1,63 +0,0 @@
===========================
Full list of builtin states
===========================
:mod:`salt.states.cmd`
======================
.. automodule:: salt.states.cmd
:members:
:mod:`salt.states.cron`
=======================
.. automodule:: salt.states.cron
:members:
:mod:`salt.states.file`
=======================
.. automodule:: salt.states.file
:members:
:mod:`salt.states.group`
========================
.. automodule:: salt.states.group
:members:
:mod:`salt.states.host`
=======================
.. automodule:: salt.states.host
:members:
:mod:`salt.states.mount`
========================
.. automodule:: salt.states.mount
:members:
:mod:`salt.states.pkg`
======================
.. automodule:: salt.states.pkg
:members:
:mod:`salt.states.service`
==========================
.. automodule:: salt.states.service
:members:
:mod:`salt.states.ssh_auth`
===========================
.. automodule:: salt.states.ssh_auth
:members:
:mod:`salt.states.user`
=======================
.. automodule:: salt.states.user
:members: