MAINT restructured the docs and bumped version

turns out re-uploading the same version to PyPI is impossible
ahugs · Feb 9, 2015 · d3449a7 · d3449a7
1 parent b157df4
commit d3449a7
Show file tree

Hide file tree

Showing 11 changed files with 42 additions and 42 deletions.
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -19,3 +19,4 @@ Authors and contributors, in no particular order:
 * Vlad Niculae
 * csytracy
 * Alexandre Gramfort
+* Sergei Lebedev
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -0,0 +1,9 @@
+hmmlearn Changelog
+==================
+
+Here you can see the full list of changes between each hmmlearn release.
+
+Version 0.1.1
+-------------
+
+Initial release, released on February 9th 2015
diff --git a/doc/api.rst b/doc/api.rst
@@ -0,0 +1,18 @@
+=============
+API Reference
+=============
+
+This is the class and function reference of ``hmmlearn``.
+
+Please refer to the :ref:`full user guide <user_guide>` for further details, as
+the class and function raw specifications may not be enough to give full
+guidelines on their uses.
+
+.. currentmodule:: hmmlearn
+
+.. autosummary::
+   :toctree: generated
+
+   hmm.GaussianHMM
+   hmm.MultinomialHMM
+   hmm.GMMHMM
diff --git a/doc/changelog.rst b/doc/changelog.rst
@@ -0,0 +1 @@
+.. include:: ../CHANGES.rst
diff --git a/doc/classes.rst b/doc/classes.rst
diff --git a/doc/conf.py b/doc/conf.py
@@ -68,10 +68,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.1'
 # The full version, including alpha/beta/rc tags.
 import hmmlearn
-release = hmmlearn.__version__
+version = release = hmmlearn.__version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/doc/index.rst b/doc/index.rst
@@ -14,7 +14,8 @@ User guide: table of contents
 .. include:: includes/big_toc_css.rst
 
 .. toctree::
-   :numbered:
+   :titlesonly:
 
-   hmm.rst
-   classes.rst
+   tutorial
+   api
+   changelog
diff --git a/doc/hmm.rst → doc/tutorial.rst b/doc/hmm.rst → doc/tutorial.rst
@@ -1,8 +1,8 @@
-.. _hmm:
+.. _tutorial:
 
-====================
-Hidden Markov Models
-====================
+========
+Tutorial
+========
 
 .. currentmodule:: hmmlearn.hmm
 

diff --git a/hmmlearn/__init__.py b/hmmlearn/__init__.py
@@ -8,7 +8,7 @@
 Historically, this code was present in ``scikit-learn``, but unmaintained.
 It has been orphaned and separated as a different package.
 """
-__version__ = '0.1.0'
+__version__ = '0.1.1'
 
 
 def setup_module(module):

diff --git a/hmmlearn/hmm.py b/hmmlearn/hmm.py
@@ -45,14 +45,14 @@ class GaussianHMM(_BaseHMM):
     n_components : int
         Number of states.
 
-    ``_covariance_type`` : string
+    covariance_type : string
         String describing the type of covariance parameters to
         use.  Must be one of 'spherical', 'tied', 'diag', 'full'.
         Defaults to 'diag'.
 
     Attributes
     ----------
-    ``_covariance_type`` : string
+    _covariance_type : string
         String describing the type of covariance parameters used by
         the model.  Must be one of 'spherical', 'tied', 'diag', 'full'.
 

diff --git a/setup.py b/setup.py
@@ -58,7 +58,7 @@
         Extension("hmmlearn._hmmc", ["hmmlearn/_hmmc.pyx"])
     ],
     requires=["sklearn"],
-    install_requires=["Cython>=0.21.2"]
+    install_requires=["Cython"]
 )