Upate the doc

Author: Guillaume Lemaitre

doc/Makefile

@@ -93,17 +93,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/project-template.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/imbalanced-learn.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/project-template.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/imbalanced-learn.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/project-template"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/project-template"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/imbalanced-learn"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/imbalanced-learn"
 	@echo "# devhelp"
 
 epub:

doc/conf.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# project-template documentation build configuration file, created by
+# imbalanced-learn documentation build configuration file, created by
 # sphinx-quickstart on Mon Jan 18 14:44:12 2016.
 #
 # This file is execfile()d with the current directory set to its
@@ -80,7 +80,7 @@
 
 # General information about the project.
 project = u'imbalanced-learn'
-copyright = u'2016, Guillaume Lemaitre, Fernando Nogueira'
+copyright = u'2016, G. Lemaitre, F. Nogueira, D. Oliveira, C. Aridas'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -212,7 +212,7 @@
 #html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'project-templatedoc'
+htmlhelp_basename = 'imbalanced-learndoc'
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -232,8 +232,8 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  ('index', 'project-template.tex', u'project-template Documentation',
-   u'Guillaume Lemaitre, Fernando Nogueira', 'manual'),
+  ('index', 'imbalanced-learn.tex', u'imbalanced-learn Documentation',
+   u'G. Lemaitre, F. Nogueira, D. Oliveira, C. Aridas', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -262,8 +262,8 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'project-template', u'project-template Documentation',
-     [u'Guillaume Lemaitre, Fernando Nogueira'], 1)
+    ('index', 'imbalanced-learn', u'imbalanced-learn Documentation',
+     [u'G. Lemaitre, F. Nogueira, D. Oliveira, C. Aridas'], 1)
 ]
 
 # If true, show URL addresses after external links.
@@ -276,8 +276,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'project-template', u'project-template Documentation',
-   u'Guillaume Lemaitre, Fernando Nogueira', 'project-template', 'One line description of project.',
+  ('index', 'imbalanced-learn', u'imbalanced-learn Documentation',
+   u'G. Lemaitre, F. Nogueira, D. Oliveira, C. Aridas', 'imbalanced-learn', 'Toolbox for imbalanced dataset in machine learning.',
    'Miscellaneous'),
 ]
 

doc/make.bat

@@ -115,9 +115,9 @@ if "%1" == "qthelp" (
 	echo.
 	echo.Build finished; now you can run "qcollectiongenerator" with the ^
 .qhcp project file in %BUILDDIR%/qthelp, like this:
-	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\project-template.qhcp
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\imbalanced-learn.qhcp
 	echo.To view the help file:
-	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\project-template.ghc
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\imbalanced-learn.ghc
 	goto end
 )