← Back to team overview

yade-dev team mailing list archive

[Branch ~yade-pkg/yade/git-trunk] Rev 3788: fixed some warnings during docs build

 

------------------------------------------------------------
revno: 3788
committer: Jan Stransky <jan.stransky@xxxxxxxxxxx>
timestamp: Thu 2016-01-28 16:00:38 +0100
message:
  fixed some warnings during docs build
modified:
  doc/references.bib
  doc/sphinx/FEMxDEM.rst
  doc/sphinx/formulation.rst
  doc/sphinx/installation.rst
  doc/yade-conferences.bib
  py/_polyhedra_utils.cpp
  py/utils.py
  py/wrapper/yadeWrapper.cpp


--
lp:yade
https://code.launchpad.net/~yade-pkg/yade/git-trunk

Your team Yade developers is subscribed to branch lp:yade.
To unsubscribe from this branch go to https://code.launchpad.net/~yade-pkg/yade/git-trunk/+edit-subscription
=== modified file 'doc/references.bib'
--- doc/references.bib	2015-11-20 00:42:30 +0000
+++ doc/references.bib	2016-01-28 15:00:38 +0000
@@ -736,7 +736,7 @@
 	language={English}
 }
 
-@article{Richarson1954,
+@article{Richardson1954,
   author = {Richardson, J. F., and W. N. Zaki},
   title = {Sedimentation and fluidization: Part i},
   journal = {Trans. Instn. Chem. Engrs},

=== modified file 'doc/sphinx/FEMxDEM.rst'
--- doc/sphinx/FEMxDEM.rst	2015-03-05 20:44:30 +0000
+++ doc/sphinx/FEMxDEM.rst	2016-01-28 15:00:38 +0000
@@ -1,4 +1,5 @@
 .. _FEMxDEM:
+
 ##############################################################################################################################
 Parallel hierarchical multiscale modeling of granular media by coupling FEM and DEM with open-source codes Escript and YADE
 ##############################################################################################################################

=== modified file 'doc/sphinx/formulation.rst'
--- doc/sphinx/formulation.rst	2015-03-05 09:45:58 +0000
+++ doc/sphinx/formulation.rst	2016-01-28 15:00:38 +0000
@@ -735,13 +735,13 @@
          K_N&=\frac{A_{\rm eq}E}{d_0}.
       \end{align*}
 
-   $d_0$ is the initial contact length, which will be, for interaction radius :eq:`eq-strain-interaction-radius` $R_I>1$, in average larger than $2R$. For $R_I=1.5$ (sect. :ref:`sect-calibration-elastic-properties`), we can roughly estimate $\overline{d}_0=1.25\cdot2R=\frac{5}{2}R$, getting
+   $d_0$ is the initial contact length, which will be, for interaction radius :eq:`eq-strain-interaction-radius` $R_I>1$, in average larger than $2R$. For $R_I=1.5$ ,we can roughly estimate $\overline{d}_0=1.25\cdot2R=\frac{5}{2}R$, getting
 
    .. math:: K_N=E\left(\frac{2}{5}\pi\right)R
 
    where $\frac{2}{5}\pi=\pi'$ by comparison with :eq:`eq-dt-kn`.
 
-   Interaction radius $R_I=1.5$ leads to average $N\approx12$ interactions per sphere for dense packing of spheres with the same radius $R$. $\xi=0.2$ is calibrated (sect. :ref:`sect-calibration-elastic-properties`) to match the desired macroscopic Poisson's ratio $\nu=0.2$.
+   Interaction radius $R_I=1.5$ leads to average $N\approx12$ interactions per sphere for dense packing of spheres with the same radius $R$. $\xi=0.2$ is calibrated to match the desired macroscopic Poisson's ratio $\nu=0.2$.
 
    Finally, we obtain the ratio
 

=== modified file 'doc/sphinx/installation.rst'
--- doc/sphinx/installation.rst	2015-12-16 06:42:29 +0000
+++ doc/sphinx/installation.rst	2016-01-28 15:00:38 +0000
@@ -34,7 +34,7 @@
 
 The Git-repository for packaging stuff is available on `GitHub <https://github.com/yade/yadedaily/>`_. 
 Each branch corresponds to one distribution, e.g., trusty, jessie etc.
-The scripts for building all of this stuff are `here <https://github.com/yade/trunk/tree/master/scripts/ppa>`_. 
+The scripts for building all of this stuff are `here <https://github.com/yade/trunk/tree/master/scripts/ppa>`__. 
 It uses "pbuilder" to build packages, so all packages are built in a clean environment.
 
 If you do not need ``yadedaily``-package any more, just remove the
@@ -87,7 +87,7 @@
 #. The development version (``trunk``) can be obtained from the `code repository <https://github.com/yade/>`_ at GitHub.
 
 We use `GIT <http://git-scm.com/>`_ (the ``git`` command) for code 
-management (install the ``git`` package on your system and create a `GitHub account <https://github.com/join/>`_)::
+management (install the ``git`` package on your system and create a `GitHub account <https://github.com/join/>`__)::
 
 		git clone git@xxxxxxxxxx:yade/trunk.git
 
@@ -98,7 +98,7 @@
 
 		git clone https://github.com/yade/trunk.git
    
-For those behind a firewall, you can download the sources from our `GitHub <https://github.com/yade>`_ repository as compressed archive.
+For those behind a firewall, you can download the sources from our `GitHub <https://github.com/yade>`__ repository as compressed archive.
 
 Release and trunk sources are compiled in exactly the same way. In order to get notifications about changes
 to the truck (i.e., ``commits``), use `watch option on GitHub <https://help.github.com/articles/watching-repositories/>`_.
@@ -304,5 +304,5 @@
 
 If you are not running Ubuntu nor Debian, there is a way to create a Yubuntu `live-usb <http://en.wikipedia.org/wiki/Live_USB>`_ on any usb mass-storage device (minimum recommended size is 5GB). It is a way to make a bootable usb-key with a preinstalled minimalist operating system (Xubuntu), including Yadedaily and Paraview.
 
-More informations about this alternative are available `here <http://geo.hmg.inpg.fr/~chareyre/pubs/yubuntu/>`_ (see the README file first).
+More informations about this alternative are available `here <http://geo.hmg.inpg.fr/~chareyre/pubs/yubuntu/>`__ (see the README file first).
 

=== modified file 'doc/yade-conferences.bib'
--- doc/yade-conferences.bib	2015-12-11 05:44:12 +0000
+++ doc/yade-conferences.bib	2016-01-28 15:00:38 +0000
@@ -797,7 +797,7 @@
   publisher={Springer}
 }
 
-@InProceedings{Wan2015,
+@InProceedings{Wan2015b,
   title={Plastic Deformations in Granular Materials with Rotation of Principal Stress Axes},
   author={Wan, Richard and Hadda, Nejib},
   booktitle={Bifurcation and Degradation of Geomaterials in the New Millennium},

=== modified file 'py/_polyhedra_utils.cpp'
--- py/_polyhedra_utils.cpp	2014-10-22 10:13:18 +0000
+++ py/_polyhedra_utils.cpp	2016-01-28 15:00:38 +0000
@@ -536,7 +536,7 @@
 	py::def("SieveCurve",SieveCurve,"save sieve curve coordinates into file");
 	py::def("SizeOfPolyhedra",SizeOfPolyhedra,"returns max, middle an min size in perpendicular directions");
 	py::def("SizeRatio",SizeRatio,"save sizes of polyhedra into file");
-	py::def("convexHull",convexHull,"....");
+	py::def("convexHull",convexHull,"TODO");
 	py::def("Split",Split,"split polyhedron perpendicularly to given direction through given point");
 }
 

=== modified file 'py/utils.py'
--- py/utils.py	2016-01-07 17:49:32 +0000
+++ py/utils.py	2016-01-28 15:00:38 +0000
@@ -34,7 +34,7 @@
 		(1, 2, 3)
 
 	those variables will be save in the .xml file, when the simulation itself is saved. To recover those variables once the .xml is loaded again, use
-	``loadVars('something')``and they will be defined in the yade.params.\ *mark* module. The *loadNow* parameter calls :yref:`yade.utils.loadVars`
+	``loadVars('something')`` and they will be defined in the yade.params.\ *mark* module. The *loadNow* parameter calls :yref:`yade.utils.loadVars`
 	after saving automatically. If 'something' already exists, given variables will be inserted.
 	"""
 	import cPickle

=== modified file 'py/wrapper/yadeWrapper.cpp'
--- py/wrapper/yadeWrapper.cpp	2016-01-28 13:24:40 +0000
+++ py/wrapper/yadeWrapper.cpp	2016-01-28 15:00:38 +0000
@@ -874,7 +874,7 @@
 		.def("withBody",&pyInteractionContainer::withBody,"Return list of real interactions of given body.")
 		.def("withBodyAll",&pyInteractionContainer::withBodyAll,"Return list of all (real as well as non-real) interactions of given body.")
 		.def("all",&pyInteractionContainer::getAll,(py::arg("onlyReal")=false),"Return list of all interactions. Virtual interaction are filtered out if onlyReal=True, else (default) it dumps the full content.")
-		.def("eraseNonReal",&pyInteractionContainer::eraseNonReal,"Erase all interactions that are not :yref:`real <InteractionContainer.isReal>`.")
+		.def("eraseNonReal",&pyInteractionContainer::eraseNonReal,"Erase all interactions that are not :yref:`real <Interaction.isReal>`.")
 		.def("erase",&pyInteractionContainer::erase,"Erase one interaction, given by id1, id2 (internally, ``requestErase`` is called -- the interaction might still exist as potential, if the :yref:`Collider` decides so).")
 		.add_property("serializeSorted",&pyInteractionContainer::serializeSorted_get,&pyInteractionContainer::serializeSorted_set)
 		.def("clear",&pyInteractionContainer::clear,"Remove all interactions, and invalidate persistent collider data (if the collider supports it).");