/docs/MercurialApp Gawel's repository

docs

authorGael Pasgrimaud <gael@gawel.org>
Sat Mar 06 20:09:34 2010 +0100 (4 months ago)
changeset 1104bd43fb13690
parent 109 a093267537a4
child 111 cdf4b92a4ef0
docs
     1.1 --- a/docs/modules/hgapp.apps.txt	Sat Mar 06 19:40:05 2010 +0100
     1.2 +++ b/docs/modules/hgapp.apps.txt	Sat Mar 06 20:09:34 2010 +0100
     1.3 @@ -3,32 +3,34 @@
     1.4  ==============================
     1.5  
     1.6  .. automodule:: hgapp.apps
     1.7 +   :undoc-members:
     1.8 +
     1.9  
    1.10  .. currentmodule:: hgapp.apps
    1.11  
    1.12  Classes
    1.13  =======
    1.14  
    1.15 -ProjectApp
    1.16 -----------
    1.17 +:class:`~hgapp.apps.DirApp`
    1.18 +--------------------------------
    1.19 +
    1.20 +.. autoclass:: DirApp 
    1.21 +   :members:
    1.22 +
    1.23 +:class:`~hgapp.apps.ProjectApp`
    1.24 +----------------------------------------
    1.25  
    1.26  .. autoclass:: ProjectApp 
    1.27     :members:
    1.28  
    1.29 -RepoApp
    1.30 --------
    1.31 +:class:`~hgapp.apps.RepoApp`
    1.32 +----------------------------------
    1.33  
    1.34  .. autoclass:: RepoApp 
    1.35     :members:
    1.36  
    1.37 -DirApp
    1.38 -------
    1.39 -
    1.40 -.. autoclass:: DirApp 
    1.41 -   :members:
    1.42 -
    1.43 -UserDirApp
    1.44 -----------
    1.45 +:class:`~hgapp.apps.UserDirApp`
    1.46 +----------------------------------------
    1.47  
    1.48  .. autoclass:: UserDirApp 
    1.49     :members:
     2.1 --- a/docs/modules/hgapp.hooks.txt	Sat Mar 06 19:40:05 2010 +0100
     2.2 +++ b/docs/modules/hgapp.hooks.txt	Sat Mar 06 20:09:34 2010 +0100
     2.3 @@ -3,6 +3,8 @@
     2.4  =================================
     2.5  
     2.6  .. automodule:: hgapp.hooks
     2.7 +   :undoc-members:
     2.8 +
     2.9  
    2.10  .. currentmodule:: hgapp.hooks
    2.11  
    2.12 @@ -11,18 +13,18 @@
    2.13  Functions
    2.14  =========
    2.15  
    2.16 -sdist_update
    2.17 -------------
    2.18 +:func:`~hgapp.hooks.sdist_update`
    2.19 +----------------------------------------------
    2.20  
    2.21  .. autofunction:: sdist_update 
    2.22  
    2.23 -sphinx_update
    2.24 --------------
    2.25 +:func:`~hgapp.hooks.sphinx_update`
    2.26 +------------------------------------------------
    2.27  
    2.28  .. autofunction:: sphinx_update 
    2.29  
    2.30 -updates
    2.31 --------
    2.32 +:func:`~hgapp.hooks.updates`
    2.33 +------------------------------------
    2.34  
    2.35  .. autofunction:: updates 
    2.36  
     3.1 --- a/docs/modules/hgapp.pool.txt	Sat Mar 06 19:40:05 2010 +0100
     3.2 +++ b/docs/modules/hgapp.pool.txt	Sat Mar 06 20:09:34 2010 +0100
     3.3 @@ -3,14 +3,16 @@
     3.4  ==============================
     3.5  
     3.6  .. automodule:: hgapp.pool
     3.7 +   :undoc-members:
     3.8 +
     3.9  
    3.10  .. currentmodule:: hgapp.pool
    3.11  
    3.12  Classes
    3.13  =======
    3.14  
    3.15 -Pool
    3.16 -----
    3.17 +:class:`~hgapp.pool.Pool`
    3.18 +----------------------------
    3.19  
    3.20  .. autoclass:: Pool 
    3.21     :members:
    3.22 @@ -20,8 +22,8 @@
    3.23  Functions
    3.24  =========
    3.25  
    3.26 -make_app
    3.27 ---------
    3.28 +:func:`~hgapp.pool.make_app`
    3.29 +------------------------------------
    3.30  
    3.31  .. autofunction:: make_app 
    3.32  
     4.1 --- a/docs/modules/hgapp.script.txt	Sat Mar 06 19:40:05 2010 +0100
     4.2 +++ b/docs/modules/hgapp.script.txt	Sat Mar 06 20:09:34 2010 +0100
     4.3 @@ -3,6 +3,8 @@
     4.4  ====================================
     4.5  
     4.6  .. automodule:: hgapp.script
     4.7 +   :undoc-members:
     4.8 +
     4.9  
    4.10  .. currentmodule:: hgapp.script
    4.11  
    4.12 @@ -11,23 +13,23 @@
    4.13  Functions
    4.14  =========
    4.15  
    4.16 -serve
    4.17 ------
    4.18 +:func:`~hgapp.script.admin`
    4.19 +----------------------------------
    4.20 +
    4.21 +.. autofunction:: admin 
    4.22 +
    4.23 +:func:`~hgapp.script.main`
    4.24 +--------------------------------
    4.25 +
    4.26 +.. autofunction:: main 
    4.27 +
    4.28 +:func:`~hgapp.script.serve`
    4.29 +----------------------------------
    4.30  
    4.31  .. autofunction:: serve 
    4.32  
    4.33 -main
    4.34 -----
    4.35 -
    4.36 -.. autofunction:: main 
    4.37 -
    4.38 -admin
    4.39 ------
    4.40 -
    4.41 -.. autofunction:: admin 
    4.42 -
    4.43 -ssh_keys
    4.44 ---------
    4.45 +:func:`~hgapp.script.ssh_keys`
    4.46 +----------------------------------------
    4.47  
    4.48  .. autofunction:: ssh_keys 
    4.49  
     5.1 --- a/docs/modules/hgapp.ssh.keys.txt	Sat Mar 06 19:40:05 2010 +0100
     5.2 +++ b/docs/modules/hgapp.ssh.keys.txt	Sat Mar 06 20:09:34 2010 +0100
     5.3 @@ -3,6 +3,8 @@
     5.4  ==========================================
     5.5  
     5.6  .. automodule:: hgapp.ssh.keys
     5.7 +   :undoc-members:
     5.8 +
     5.9  
    5.10  .. currentmodule:: hgapp.ssh.keys
    5.11  
    5.12 @@ -11,54 +13,54 @@
    5.13  Functions
    5.14  =========
    5.15  
    5.16 -del_user
    5.17 ---------
    5.18 +:func:`~hgapp.ssh.keys.add_key`
    5.19 +------------------------------------------
    5.20 +
    5.21 +.. autofunction:: add_key 
    5.22 +
    5.23 +:func:`~hgapp.ssh.keys.authorized_keys`
    5.24 +----------------------------------------------------------
    5.25 +
    5.26 +.. autofunction:: authorized_keys 
    5.27 +
    5.28 +:func:`~hgapp.ssh.keys.chmod`
    5.29 +--------------------------------------
    5.30 +
    5.31 +.. autofunction:: chmod 
    5.32 +
    5.33 +:func:`~hgapp.ssh.keys.del_key`
    5.34 +------------------------------------------
    5.35 +
    5.36 +.. autofunction:: del_key 
    5.37 +
    5.38 +:func:`~hgapp.ssh.keys.del_user`
    5.39 +--------------------------------------------
    5.40  
    5.41  .. autofunction:: del_user 
    5.42  
    5.43 -authorized_keys
    5.44 ----------------
    5.45 +:func:`~hgapp.ssh.keys.gen_keys`
    5.46 +--------------------------------------------
    5.47  
    5.48 -.. autofunction:: authorized_keys 
    5.49 +.. autofunction:: gen_keys 
    5.50  
    5.51 -add_key
    5.52 --------
    5.53 +:func:`~hgapp.ssh.keys.get_user_keys`
    5.54 +------------------------------------------------------
    5.55  
    5.56 -.. autofunction:: add_key 
    5.57 +.. autofunction:: get_user_keys 
    5.58  
    5.59 -del_key
    5.60 --------
    5.61 +:func:`~hgapp.ssh.keys.user_dir`
    5.62 +--------------------------------------------
    5.63  
    5.64 -.. autofunction:: del_key 
    5.65 +.. autofunction:: user_dir 
    5.66  
    5.67 -user_keys
    5.68 ----------
    5.69 +:func:`~hgapp.ssh.keys.user_keys`
    5.70 +----------------------------------------------
    5.71  
    5.72  .. autofunction:: user_keys 
    5.73  
    5.74 -get_user_keys
    5.75 --------------
    5.76 -
    5.77 -.. autofunction:: get_user_keys 
    5.78 -
    5.79 -gen_keys
    5.80 ---------
    5.81 -
    5.82 -.. autofunction:: gen_keys 
    5.83 -
    5.84 -chmod
    5.85 ------
    5.86 -
    5.87 -.. autofunction:: chmod 
    5.88 -
    5.89 -users
    5.90 ------
    5.91 +:func:`~hgapp.ssh.keys.users`
    5.92 +--------------------------------------
    5.93  
    5.94  .. autofunction:: users 
    5.95  
    5.96 -user_dir
    5.97 ---------
    5.98  
    5.99 -.. autofunction:: user_dir 
   5.100 -
   5.101 -
     6.1 --- a/docs/modules/hgapp.ssh.shell.txt	Sat Mar 06 19:40:05 2010 +0100
     6.2 +++ b/docs/modules/hgapp.ssh.shell.txt	Sat Mar 06 20:09:34 2010 +0100
     6.3 @@ -3,6 +3,8 @@
     6.4  =============================================
     6.5  
     6.6  .. automodule:: hgapp.ssh.shell
     6.7 +   :undoc-members:
     6.8 +
     6.9  
    6.10  .. currentmodule:: hgapp.ssh.shell
    6.11  
    6.12 @@ -11,8 +13,8 @@
    6.13  Functions
    6.14  =========
    6.15  
    6.16 -main
    6.17 -----
    6.18 +:func:`~hgapp.ssh.shell.main`
    6.19 +--------------------------------------
    6.20  
    6.21  .. autofunction:: main 
    6.22  
     7.1 --- a/docs/modules/hgapp.utils.txt	Sat Mar 06 19:40:05 2010 +0100
     7.2 +++ b/docs/modules/hgapp.utils.txt	Sat Mar 06 20:09:34 2010 +0100
     7.3 @@ -3,6 +3,8 @@
     7.4  =================================
     7.5  
     7.6  .. automodule:: hgapp.utils
     7.7 +   :undoc-members:
     7.8 +
     7.9  
    7.10  .. currentmodule:: hgapp.utils
    7.11  
    7.12 @@ -11,54 +13,54 @@
    7.13  Functions
    7.14  =========
    7.15  
    7.16 -get_repo
    7.17 ---------
    7.18 +:func:`~hgapp.utils.check_perm`
    7.19 +------------------------------------------
    7.20 +
    7.21 +.. autofunction:: check_perm 
    7.22 +
    7.23 +:func:`~hgapp.utils.cmd`
    7.24 +----------------------------
    7.25 +
    7.26 +.. autofunction:: cmd 
    7.27 +
    7.28 +:func:`~hgapp.utils.get_binary`
    7.29 +------------------------------------------
    7.30 +
    7.31 +.. autofunction:: get_binary 
    7.32 +
    7.33 +:func:`~hgapp.utils.get_repo`
    7.34 +--------------------------------------
    7.35  
    7.36  .. autofunction:: get_repo 
    7.37  
    7.38 -run
    7.39 ----
    7.40 +:func:`~hgapp.utils.get_ui`
    7.41 +----------------------------------
    7.42 +
    7.43 +.. autofunction:: get_ui 
    7.44 +
    7.45 +:func:`~hgapp.utils.hgrc`
    7.46 +------------------------------
    7.47 +
    7.48 +.. autofunction:: hgrc 
    7.49 +
    7.50 +:func:`~hgapp.utils.is_repository`
    7.51 +------------------------------------------------
    7.52 +
    7.53 +.. autofunction:: is_repository 
    7.54 +
    7.55 +:func:`~hgapp.utils.isfile`
    7.56 +----------------------------------
    7.57 +
    7.58 +.. autofunction:: isfile 
    7.59 +
    7.60 +:func:`~hgapp.utils.load_config`
    7.61 +--------------------------------------------
    7.62 +
    7.63 +.. autofunction:: load_config 
    7.64 +
    7.65 +:func:`~hgapp.utils.run`
    7.66 +----------------------------
    7.67  
    7.68  .. autofunction:: run 
    7.69  
    7.70 -isfile
    7.71 -------
    7.72  
    7.73 -.. autofunction:: isfile 
    7.74 -
    7.75 -load_config
    7.76 ------------
    7.77 -
    7.78 -.. autofunction:: load_config 
    7.79 -
    7.80 -get_binary
    7.81 -----------
    7.82 -
    7.83 -.. autofunction:: get_binary 
    7.84 -
    7.85 -get_ui
    7.86 -------
    7.87 -
    7.88 -.. autofunction:: get_ui 
    7.89 -
    7.90 -check_perm
    7.91 -----------
    7.92 -
    7.93 -.. autofunction:: check_perm 
    7.94 -
    7.95 -cmd
    7.96 ----
    7.97 -
    7.98 -.. autofunction:: cmd 
    7.99 -
   7.100 -hgrc
   7.101 -----
   7.102 -
   7.103 -.. autofunction:: hgrc 
   7.104 -
   7.105 -is_repository
   7.106 --------------
   7.107 -
   7.108 -.. autofunction:: is_repository 
   7.109 -
   7.110 -