Documentation changes.

doc/Makefile

@@ -77,17 +77,17 @@ qthelp:
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/test1.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/vsm.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/test1.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/vsm.qhc"
 
 devhelp:
 	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 	@echo
 	@echo "Build finished."
 	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/test1"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/test1"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/vsm"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/vsm"
 	@echo "# devhelp"
 
 epub:
@@ -151,3 +151,15 @@ doctest:
 	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 	@echo "Testing of doctests in the sources finished, look at the " \
 	      "results in $(BUILDDIR)/doctest/output.txt."
+
+gh-pages:
+	make html
+	git clone https://github.com/inpho/vsm vsm_gh_pages
+	cd vsm_gh_pages \
+	&& git checkout gh-pages \
+	&& rm -rf * _static _sources \
+	&& mv ../$(BUILDDIR)/html/* . \
+	&& git add -A \
+	&& git commit -m "Generated gh-pages" \
+	&& git push origin gh-pages
+	rm -rf $(BUILDDIR) vsm_gh_pages

doc/source/conf.py

@@ -49,9 +49,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.1'
+version = '0.2'
 # The full version, including alpha/beta/rc tags.
-release = '0.1'
+release = '0.2'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -251,4 +251,4 @@
 epub_title = u'vsm'
 epub_author = u'vsm development team'
 epub_publisher = u'vsm development team'
-epub_copyright = u'2013, vsm development team'
+epub_copyright = u'2014, vsm development team'

vsm/model/ldacgsmulti.py

@@ -232,10 +232,9 @@ def train(self, n_iterations=500, verbose=True, n_proc=2, seeds=None):
             2.
         :type n_proc: int, optional
         
-        :param seeds: List of arbitrary starting points for each processors.
-            The length of the list should be same as `n_proc`. If `None`,
-            each threads start at a random seed. Default is `None`.
-        :type seeds: list, optional
+        :param seeds: List of random seeds, one for each thread.
+            The length of the list should be same as `n_proc`. Default is `None`.
+        :type seeds: list of integers, optional
         """
         self._move_locals_to_globals()
 

vsm/model/ldacgsseq.py

@@ -107,9 +107,8 @@ def train(self, n_iterations=100, verbose=1, seed=None):
             are printed out to notify the user. Default is 1.
         :type verbose: int, optional
 
-        :param seeds: An arbitrary starting point. If `None` it will
-            start at a random seed. Default is `None`.
-        :type seeds: double, optional
+        :param seed: Seed for numpy's RandomState. Default is `None`.
+        :type seed: int, optional
         """
         random_state = np.random.RandomState(seed)
         mtrand_state = random_state.get_state()