climate-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jo...@apache.org
Subject svn commit: r1535862 - /incubator/climate/trunk/docs/source/conf.py
Date Fri, 25 Oct 2013 20:46:15 GMT
Author: joyce
Date: Fri Oct 25 20:46:14 2013
New Revision: 1535862

URL: http://svn.apache.org/r1535862
Log:
CLIMATE-311 - Modify default autodoc class doc-ing behavior

- Set autoclass_content to "both". This means that when using
  autoclass the class' docstring will be concatenated with its __init__
  method's docstring to form the main body of the autoclass directive.

Modified:
    incubator/climate/trunk/docs/source/conf.py

Modified: incubator/climate/trunk/docs/source/conf.py
URL: http://svn.apache.org/viewvc/incubator/climate/trunk/docs/source/conf.py?rev=1535862&r1=1535861&r2=1535862&view=diff
==============================================================================
--- incubator/climate/trunk/docs/source/conf.py (original)
+++ incubator/climate/trunk/docs/source/conf.py Fri Oct 25 20:46:14 2013
@@ -254,3 +254,11 @@ texinfo_documents = [
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'http://docs.python.org/': None}
+
+# Autodoc config
+#
+# Select which content is inserted into the main body of an autoclass directive
+# "class" - Only the class' docstring
+# "both"  - The class' and __init__ method's docstring
+# "init"  - Only __init__'s docstring
+autoclass_content = "both"



Mime
View raw message