Merge pull request #36 from mtezzele/docs

add summaries, add missing methods in the doc
mathLab · Jan 15, 2019 · dbc846e · dbc846e
2 parents 6f515dd + 9c67a58
commit dbc846e
Show file tree

Hide file tree

Showing 12 changed files with 59 additions and 3 deletions.
diff --git a/LICENSE.rst b/LICENSE.rst
@@ -3,7 +3,7 @@ License
 
 The MIT License (MIT)
 
-Copyright (c) 2017-2018 BladeX contributors
+Copyright (c) 2017-2019 BladeX contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/docs/source/_summaries/bladex.blade.Blade._generate_lower_face.rst b/docs/source/_summaries/bladex.blade.Blade._generate_lower_face.rst
@@ -0,0 +1,6 @@
+bladex.blade.Blade._generate_lower_face
+=======================================
+
+.. currentmodule:: bladex.blade
+
+.. automethod:: Blade._generate_lower_face
diff --git a/docs/source/_summaries/bladex.blade.Blade._generate_tip.rst b/docs/source/_summaries/bladex.blade.Blade._generate_tip.rst
@@ -0,0 +1,6 @@
+bladex.blade.Blade._generate_tip
+================================
+
+.. currentmodule:: bladex.blade
+
+.. automethod:: Blade._generate_tip
diff --git a/docs/source/_summaries/bladex.blade.Blade._generate_upper_face.rst b/docs/source/_summaries/bladex.blade.Blade._generate_upper_face.rst
@@ -0,0 +1,6 @@
+bladex.blade.Blade._generate_upper_face
+=======================================
+
+.. currentmodule:: bladex.blade
+
+.. automethod:: Blade._generate_upper_face
diff --git a/docs/source/_summaries/bladex.blade.Blade._import_occ_libs.rst b/docs/source/_summaries/bladex.blade.Blade._import_occ_libs.rst
@@ -0,0 +1,6 @@
+bladex.blade.Blade._import_occ_libs
+===================================
+
+.. currentmodule:: bladex.blade
+
+.. automethod:: Blade._import_occ_libs
diff --git a/docs/source/_summaries/bladex.blade.Blade._write_blade_errors.rst b/docs/source/_summaries/bladex.blade.Blade._write_blade_errors.rst
@@ -0,0 +1,6 @@
+bladex.blade.Blade._write_blade_errors
+======================================
+
+.. currentmodule:: bladex.blade
+
+.. automethod:: Blade._write_blade_errors
diff --git a/docs/source/_summaries/bladex.blade.Blade.generate_stl.rst b/docs/source/_summaries/bladex.blade.Blade.generate_stl.rst
@@ -0,0 +1,6 @@
+bladex.blade.Blade.generate_stl
+===============================
+
+.. currentmodule:: bladex.blade
+
+.. automethod:: Blade.generate_stl
diff --git a/docs/source/_summaries/bladex.blade.Blade.rotate.rst b/docs/source/_summaries/bladex.blade.Blade.rotate.rst
@@ -0,0 +1,6 @@
+bladex.blade.Blade.rotate
+=========================
+
+.. currentmodule:: bladex.blade
+
+.. automethod:: Blade.rotate
diff --git a/docs/source/_summaries/bladex.ndinterpolator.scipy_bspline.rst b/docs/source/_summaries/bladex.ndinterpolator.scipy_bspline.rst
@@ -0,0 +1,6 @@
+bladex.ndinterpolator.scipy_bspline
+===================================
+
+.. currentmodule:: bladex.ndinterpolator
+
+.. autofunction:: scipy_bspline
diff --git a/docs/source/blade.rst b/docs/source/blade.rst
@@ -14,13 +14,20 @@ Blade
 	Blade._check_params
 	Blade._check_string
 	Blade._compute_pitch_angle
+	Blade._generate_lower_face
+	Blade._generate_tip
+	Blade._generate_upper_face
+	Blade._import_occ_libs
 	Blade._induced_rake_from_skew
 	Blade._norm_to_abs
 	Blade._planar_to_cylindrical
+	Blade._write_blade_errors
 	Blade.apply_transformations
 	Blade.generate_iges
+	Blade.generate_stl
 	Blade.export_ppg
 	Blade.plot
+	Blade.rotate
 
 
 .. autoclass:: Blade

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -21,12 +21,12 @@ BladeX is compatible with Python 2.7 and Python 3.6. Moreover, some of the modul
 Python2.7 OCC installation:
 ::
 
-  conda install -c conda-forge -c dlr-sc -c pythonocc -c oce pythonocc-core==0.18.1 python=2.7
+  conda install -c conda-forge -c dlr-sc -c pythonocc -c oce pythonocc-core==0.18.1 smesh=6.7.5 python=2.7
 
 Python3.6 OCC installation:
 ::
 
-  conda install -c conda-forge -c dlr-sc -c pythonocc -c oce pythonocc-core==0.18.1 python=3.6
+  conda install -c conda-forge -c dlr-sc -c pythonocc -c oce pythonocc-core==0.18.1 smesh=6.7.5 python=3.6
 
 
 The `official distribution <https://github.com/mathLab/BladeX>`_ is on GitHub, and you can clone the repository using

diff --git a/docs/source/ndinterpolator.rst b/docs/source/ndinterpolator.rst
@@ -16,6 +16,7 @@ Ndinterpolator
 	RBF.thin_plate_spline
 	RBF.weights_matrix
 	reconstruct_f
+	scipy_bspline
 
 
 .. automodule:: bladex.ndinterpolator