New Version: switch to Sphinx documentation

T-002 · T-002 · commit cd956e974a04 · 2012-11-18T12:53:25.000+01:00
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -1,3 +1,4 @@
+v0.0.8-prealpha, 2012-11-18 -- Error Values, Sphinx documentation
 v0.0.7-prealpha, 2012-11-11 -- First Error measures implemented
 v0.0.6-prealpha, 2012-11-01 -- Started implementation of error measures
 v0.0.5-prealpha, 2012-10-20 -- Included test suite with code coverage into pycast
diff --git a/docs/build/latex/pycast.pdf b/docs/build/latex/pycast.pdf
diff --git a/docs/source/common.rst b/docs/source/common.rst
@@ -4,11 +4,5 @@ pycast.common
 =============
 
 .. automodule:: pycast.common.profileme
-   :members:
-   :special-members:
 
-.. automodule:: pycast.common.helper
-   :members:
-   :special-members:
-
-.. automodule:: pycast.common.timeseries
+.. automodule:: pycast.common.helper
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -53,7 +53,7 @@
 # The short X.Y version.
 version = '0.0'
 # The full version, including alpha/beta/rc tags.
-release = '0.0.7-prealpha'
+release = 'v0.0.8-prealpha'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -89,8 +89,12 @@
 # A list of ignored prefixes for module index sorting.
 #modindex_common_prefix = []
 
-## automatic documentation of __*__ members
-# autoclass_content = "both"
+## auto-doc adjustments
+#autoclass_skip_member = ["__weakref__"]
+#autoclass_content = "both"
+autodoc_member_order  = "groupwise" # "bysource" # "alphabetical"
+autodoc_default_flags =  ["members", "private-members", "special-members", "show-inheritance"] #  "undoc-members" "inherited-members"
+
 
 # -- Options for HTML output ---------------------------------------------------
 
diff --git a/docs/source/errors.rst b/docs/source/errors.rst
@@ -4,13 +4,7 @@ Error Measures
 ==============
 
 .. autoclass:: pycast.errors.BaseErrorMeasure
-   :members:
-   :special-members:
 
 .. autoclass:: pycast.errors.MeanSquaredError
-   :members:
-   :special-members:
 
-.. autoclass:: pycast.errors.SymmetricMeanAbsolutePercentageError
-   :members:
-   :special-members:
+.. autoclass:: pycast.errors.SymmetricMeanAbsolutePercentageError
diff --git a/docs/source/forecastingmethods.rst b/docs/source/forecastingmethods.rst
@@ -4,9 +4,5 @@ Forecasting Methods
 ===================
 
 .. autoclass:: pycast.methods.ExponentialSmoothing
-   :members:
-   :special-members:
 
-.. autoclass:: pycast.methods.HoltMethod
-   :members:
-   :special-members:
+.. autoclass:: pycast.methods.HoltMethod
diff --git a/docs/source/optimization.rst b/docs/source/optimization.rst
@@ -4,9 +4,5 @@ Optimization Methods
 ====================
 
 .. autoclass:: pycast.optimization.BaseOptimizationMethod
-   :members:
-   :special-members:
 
-.. autoclass:: pycast.optimization.GridSearch
-   :members:
-   :special-members:
+.. autoclass:: pycast.optimization.GridSearch
diff --git a/docs/source/smoothingmethods.rst b/docs/source/smoothingmethods.rst
@@ -3,6 +3,4 @@
 Smoothing Methods
 ===================
 
-.. autoclass:: pycast.methods.SimpleMovingAverage
-   :members:
-   :special-members:
+.. autoclass:: pycast.methods.SimpleMovingAverage
diff --git a/docs/source/timeseries.rst b/docs/source/timeseries.rst
@@ -3,6 +3,4 @@
 TimeSeries
 ==========
 
-.. autoclass:: pycast.common.timeseries.TimeSeries
-   :members:
-   :special-members:
+.. autoclass:: pycast.common.timeseries.TimeSeries
diff --git a/setup.py b/setup.py
@@ -2,7 +2,7 @@
 
 setup(
     name             = "pycast",
-    version          = "v0.0.7-prealpha",
+    version          = "v0.0.8-prealpha",
     author           = "Christian Schwarz",
     author_email     = "pixeldreck@gmail.com",
     packages         = ["pycast"],

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+v0.0.8-prealpha, 2012-11-18 -- Error Values, Sphinx documentation`
`1`	`2`	`v0.0.7-prealpha, 2012-11-11 -- First Error measures implemented`
`2`	`3`	`v0.0.6-prealpha, 2012-11-01 -- Started implementation of error measures`
`3`	`4`	`v0.0.5-prealpha, 2012-10-20 -- Included test suite with code coverage into pycast`