Changeset 30b60d2 in sasmodels for doc

Timestamp:

Sep 5, 2017 2:39:41 PM (7 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master, core_shell_microgels, costrafo411, magnetic_model, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

3a45c2c

Parents:

64eecf7

Message:

allow build of both latex and html

Location:

doc

Files:

• conf.py (modified) (1 diff)
• guide/magnetism/mag_img/mag_vector.png (moved) (moved from doc/ref/magnetism/mag_img/mag_vector.png)
• guide/plugin.rst (modified) (9 diffs)
• guide/resolution.rst (modified) (1 diff)
• guide/resolution_2d_rotation.gif (deleted)
• guide/resolution_2d_rotation.png (added)
• rst_prolog (modified) (2 diffs)

doc/conf.py

@@ -211 +211 @@
 #latex_preamble = ''
 LATEX_PREAMBLE=r"""
+\newcommand{\lt}{<}
+\newcommand{\gt}{>}
 \renewcommand{\AA}{\text{\r{A}}} % Allow \AA in math mode
 \usepackage[utf8]{inputenc}      % Allow unicode symbols in text

doc/guide/plugin.rst

@@ -117 +117 @@
 Models that do not conform to these requirements will *never* be incorporated
 into the built-in library.
-
-More complete documentation for the sasmodels package can be found at
-`<http://www.sasview.org/sasmodels>`_. In particular,
-`<http://www.sasview.org/sasmodels/api/generate.html#module-sasmodels.generate>`_
-describes the structure of a model.
 
 
@@ -613 +608 @@
 
     sas_gamma(x):
-        Gamma function $\text{sas_gamma}(x) = \Gamma(x)$.
+        Gamma function sas_gamma\ $(x) = \Gamma(x)$.
 
         The standard math function, tgamma(x) is unstable for $x < 1$
@@ -623 +618 @@
     sas_erf(x), sas_erfc(x):
         Error function
-        $\text{sas_erf}(x) = \frac{2}{\sqrt\pi}\int_0^x e^{-t^2}\,dt$
+        sas_erf\ $(x) = \frac{2}{\sqrt\pi}\int_0^x e^{-t^2}\,dt$
         and complementary error function
-        $\text{sas_erfc}(x) = \frac{2}{\sqrt\pi}\int_x^{\infty} e^{-t^2}\,dt$.
+        sas_erfc\ $(x) = \frac{2}{\sqrt\pi}\int_x^{\infty} e^{-t^2}\,dt$.
 
         The standard math functions erf(x) and erfc(x) are slower and broken
@@ -634 +629 @@
 
     sas_J0(x):
-        Bessel function of the first kind $\text{sas_J0}(x)=J_0(x)$ where
+        Bessel function of the first kind sas_J0\ $(x)=J_0(x)$ where
         $J_0(x) = \frac{1}{\pi}\int_0^\pi \cos(x\sin(\tau))\,d\tau$.
 
@@ -643 +638 @@
 
     sas_J1(x):
-        Bessel function of the first kind  $\text{sas_J1}(x)=J_1(x)$ where
+        Bessel function of the first kind  sas_J1\ $(x)=J_1(x)$ where
         $J_1(x) = \frac{1}{\pi}\int_0^\pi \cos(\tau - x\sin(\tau))\,d\tau$.
 
@@ -652 +647 @@
 
     sas_JN(n, x):
-        Bessel function of the first kind and integer order $n$:
-        $\text{sas_JN}(n, x)=J_n(x)$ where
+        Bessel function of the first kind and integer order $n$,
+        sas_JN\ $(n, x) =J_n(x)$ where
         $J_n(x) = \frac{1}{\pi}\int_0^\pi \cos(n\tau - x\sin(\tau))\,d\tau$.
-        If $n$ = 0 or 1, it uses sas_J0(x) or sas_J1(x), respectively.
+        If $n$ = 0 or 1, it uses sas_J0($x$) or sas_J1($x$), respectively.
 
         The standard math function jn(n, x) is not available on all platforms.
@@ -663 +658 @@
 
     sas_Si(x):
-        Sine integral $\text{Si}(x) = \int_0^x \tfrac{\sin t}{t}\,dt$.
+        Sine integral Si\ $(x) = \int_0^x \tfrac{\sin t}{t}\,dt$.
 
         This function uses Taylor series for small and large arguments:
@@ -688 +683 @@
     sas_3j1x_x(x):
         Spherical Bessel form
-        $\text{sph_j1c}(x) = 3 j_1(x)/x = 3 (\sin(x) - x \cos(x))/x^3$,
+        sph_j1c\ $(x) = 3 j_1(x)/x = 3 (\sin(x) - x \cos(x))/x^3$,
         with a limiting value of 1 at $x=0$, where $j_1(x)$ is the spherical
         Bessel function of the first kind and first order.
@@ -699 +694 @@
 
     sas_2J1x_x(x):
-        Bessel form $\text{sas_J1c}(x) = 2 J_1(x)/x$, with a limiting value
+        Bessel form sas_J1c\ $(x) = 2 J_1(x)/x$, with a limiting value
         of 1 at $x=0$, where $J_1(x)$ is the Bessel function of first kind
         and first order.

doc/guide/resolution.rst

@@ -212 +212 @@
 elliptical Gaussian distribution. The $A$ is a normalization factor.
 
-.. figure:: resolution_2d_rotation.gif
+.. figure:: resolution_2d_rotation.png
 
     Coordinate axis rotation for 2D resolution calculation.

doc/rst_prolog

@@ -1 +1 @@
 .. Set up some substitutions to make life easier...
-.. Remove |biggamma|, etc. when they are no longer needed.
-
-
-    .. |alpha| unicode:: U+03B1
-    .. |beta| unicode:: U+03B2
-    .. |gamma| unicode:: U+03B3
-    .. |delta| unicode:: U+03B4
-    .. |epsilon| unicode:: U+03B5
-    .. |zeta| unicode:: U+03B6
-    .. |eta| unicode:: U+03B7
-    .. |theta| unicode:: U+03B8
-    .. |iota| unicode:: U+03B9
-    .. |kappa| unicode:: U+03BA
-    .. |lambda| unicode:: U+03BB
-    .. |mu| unicode:: U+03BC
-    .. |nu| unicode:: U+03BD
-    .. |xi| unicode:: U+03BE
-    .. |omicron| unicode:: U+03BF
-    .. |pi| unicode:: U+03C0
-    .. |rho| unicode:: U+03C1
-    .. |sigma| unicode:: U+03C3
-    .. |tau| unicode:: U+03C4
-    .. |upsilon| unicode:: U+03C5
-    .. |phi| unicode:: U+03C6
-    .. |chi| unicode:: U+03C7
-    .. |psi| unicode:: U+03C8
-    .. |omega| unicode:: U+03C9
-
-
-    .. |biggamma| unicode:: U+0393
-    .. |bigdelta| unicode:: U+0394
-    .. |bigzeta| unicode:: U+039E
-    .. |bigpsi| unicode:: U+03A8
-    .. |bigphi| unicode:: U+03A6
-    .. |bigsigma| unicode:: U+03A3
-    .. |Gamma| unicode:: U+0393
-    .. |Delta| unicode:: U+0394
-    .. |Zeta| unicode:: U+039E
-    .. |Psi| unicode:: U+03A8
-
-    .. |drho| replace:: |Delta|\ |rho|
-    .. |equiv| unicode:: U+2261
-    .. |noteql| unicode:: U+2260
-    .. |TM| unicode:: U+2122
-    .. |P0| replace:: P\ :sub:`0`\
-    .. |A2| replace:: A\ :sub:`2`\
 
 .. |Ang| unicode:: U+212B
@@ -63 +17 @@
 .. |sr^-1| replace:: sr\ :sup:`-1`
 
-
-
 .. |cdot| unicode:: U+00B7
 .. |deg| unicode:: U+00B0