rtd theme for shpinx and docs

Author: mtezzele

docs/source/_tutorials/pictures/cylinder_mod.png

@@ -17,6 +17,7 @@
 import shlex
 import sphinx
 from sphinx.errors import VersionRequirementError
+import sphinx_rtd_theme
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -67,7 +68,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'pygem'
+project = u'PyGeM'
 copyright = u'2016, Filippo Salmoiraghi, Marco Tezzele'
 author = u'Filippo Salmoiraghi, Marco Tezzele'
 
@@ -79,7 +80,7 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.1'
+version = '0.2'
 # The full version, including alpha/beta/rc tags.
 release = version
 
@@ -132,15 +133,16 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'bizstyle'
+#html_theme = 'bizstyle'
+html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".

docs/source/_tutorials/pictures/cylinder_orig.png

@@ -29,6 +29,7 @@ Guide
 
    code
    contact
+   contributing
    LICENSE
 
 
@@ -38,6 +39,7 @@ Tutorials
 We made some tutorial examples:
 
 - `Tutorial 1 <tutorial1stl.html>`_ shows how to deal with stl files
+- `Turorial 2 <tutorial2iges.html>`_ show how to deal with iges files
 
 
 

docs/source/_tutorials/tutorial1stl.html

@@ -122,6 +122,8 @@ def write(self, mesh_points, filename, tolerance=None):
 		:param numpy.ndarray mesh_points: it is a `n_points`-by-3 matrix containing
 			the coordinates of the points of the mesh
 		:param string filename: name of the output file.
+		:param float tolerance: tolerance for the construction of the faces and wires
+			in the write function. If not given it uses `self.tolerance`.
 		"""
 		self._check_filename_type(filename)
 		self._check_extension(filename)

docs/source/_tutorials/tutorial2iges.html

@@ -8,19 +8,19 @@ def readme():
 		return f.read()
 
 setup(name='pygem',
-	  version='0.1',
+	  version='0.2',
 	  description='Tools to apply FFD.',
 	  long_description=readme(),
 	  classifiers=[
-	  	'Development Status :: 3 - Alpha',
+	  	'Development Status :: 4 - Beta',
 	  	'License :: OSI Approved :: MIT License',
 	  	'Programming Language :: Python :: 2.7',
 	  	'Intended Audience :: Science/Research',
 	  	'Topic :: Scientific/Engineering :: Mathematics'
 	  ],
-	  keywords='dimension reduction mathematics ffd',
+	  keywords='dimension_reduction mathematics ffd morphing iges stl vtk openfoam',
 	  url='https://github.com/mathLab/PyGeM',
-	  authors='Filippo Salmoiraghi, Marco Tezzele',
+	  author='Filippo Salmoiraghi, Marco Tezzele',
 	  author_email='[email protected], [email protected]',
 	  license='MIT',
 	  packages=['pygem'],
@@ -29,7 +29,9 @@ def readme():
 	  		'numpy-stl',
 	  		'scipy',
 	  		'matplotlib',
-	  		'enum34'
+	  		'enum34',
+	  		'Sphinx>=1.4',
+	  		'sphinx_rtd_theme'
 	  ],
 	  test_suite='nose.collector',
 	  tests_require=['nose'],