diff options
| author | Chris St. Pierre <chris.a.st.pierre@gmail.com> | 2012-10-11 08:37:44 -0400 |
|---|---|---|
| committer | Chris St. Pierre <chris.a.st.pierre@gmail.com> | 2012-10-11 08:37:44 -0400 |
| commit | 25200caaef3230d49be47e8e19de88819a0986d1 (patch) | |
| tree | d4a5f7450462e849d9fe35cee086e50ed1adf794 | |
| parent | 65c527340628bd24c5b478d15f22d811ddb0d437 (diff) | |
| download | bcfg2-25200caaef3230d49be47e8e19de88819a0986d1.tar.gz bcfg2-25200caaef3230d49be47e8e19de88819a0986d1.tar.bz2 bcfg2-25200caaef3230d49be47e8e19de88819a0986d1.zip | |
fixed docs for Apt and Pac collections. can haz sphinx 1.1 yet?
| -rw-r--r-- | src/lib/Bcfg2/Server/Plugins/Packages/Apt.py | 13 | ||||
| -rw-r--r-- | src/lib/Bcfg2/Server/Plugins/Packages/Collection.py | 1 | ||||
| -rw-r--r-- | src/lib/Bcfg2/Server/Plugins/Packages/Pac.py | 14 |
3 files changed, 27 insertions, 1 deletions
diff --git a/src/lib/Bcfg2/Server/Plugins/Packages/Apt.py b/src/lib/Bcfg2/Server/Plugins/Packages/Apt.py index 11355e117..ec0d8e828 100644 --- a/src/lib/Bcfg2/Server/Plugins/Packages/Apt.py +++ b/src/lib/Bcfg2/Server/Plugins/Packages/Apt.py @@ -13,6 +13,19 @@ class AptCollection(Collection): overrides nothing, and defers all operations to :class:`PacSource` """ + def __init__(self, metadata, sources, cachepath, basepath, fam, + debug=False): + # we define an __init__ that just calls the parent __init__, + # so that we can set the docstring on __init__ to something + # different from the parent __init__ -- namely, the parent + # __init__ docstring, minus everything after ``.. -----``, + # which we use to delineate the actual docs from the + # .. autoattribute hacks we have to do to get private + # attributes included in sphinx 1.0 """ + Collection.__init__(self, metadata, sources, cachepath, basepath, fam, + debug=debug) + __init__.__doc__ = Collection.__init__.__doc__.split(".. -----")[0] + def get_config(self): """ Get an APT configuration file (i.e., ``sources.list``). diff --git a/src/lib/Bcfg2/Server/Plugins/Packages/Collection.py b/src/lib/Bcfg2/Server/Plugins/Packages/Collection.py index ec9ba550b..f9bb9e1a2 100644 --- a/src/lib/Bcfg2/Server/Plugins/Packages/Collection.py +++ b/src/lib/Bcfg2/Server/Plugins/Packages/Collection.py @@ -117,6 +117,7 @@ class Collection(list, Bcfg2.Server.Plugin.Debuggable): :param debug: Enable debugging output :type debug: bool + .. ----- .. autoattribute:: __package_groups__ """ Bcfg2.Server.Plugin.Debuggable.__init__(self) diff --git a/src/lib/Bcfg2/Server/Plugins/Packages/Pac.py b/src/lib/Bcfg2/Server/Plugins/Packages/Pac.py index ac58f4c99..99aed5ce5 100644 --- a/src/lib/Bcfg2/Server/Plugins/Packages/Pac.py +++ b/src/lib/Bcfg2/Server/Plugins/Packages/Pac.py @@ -11,7 +11,19 @@ class PacCollection(Collection): :class:`Bcfg2.Server.Plugins.Packages.Collection.Collection`, overrides nothing, and defers all operations to :class:`PacSource` """ - pass + + def __init__(self, metadata, sources, cachepath, basepath, fam, + debug=False): + # we define an __init__ that just calls the parent __init__, + # so that we can set the docstring on __init__ to something + # different from the parent __init__ -- namely, the parent + # __init__ docstring, minus everything after ``.. -----``, + # which we use to delineate the actual docs from the + # .. autoattribute hacks we have to do to get private + # attributes included in sphinx 1.0 """ + Collection.__init__(self, metadata, sources, cachepath, basepath, fam, + debug=debug) + __init__.__doc__ = Collection.__init__.__doc__.split(".. -----")[0] class PacSource(Source): |