doc/stdlib: add specfun

JuliaLang · May 28, 2012 · f16e1fa · f16e1fa
1 parent 504b953
commit f16e1fa
Show file tree

Hide file tree

Showing 4 changed files with 62 additions and 2 deletions.
diff --git a/doc/README.md b/doc/README.md
@@ -30,5 +30,6 @@ File layout
     helpdb.jl           REPL help database
     sphinx/             Sphinx extensions and plugins
     sphinx/jlhelp.py    Sphinx plugin to build helpdb.jl
-
+    stdlib/             Julia standard library documentation
+    _themes/            Sphinx html themes
 
diff --git a/doc/conf.py b/doc/conf.py
@@ -75,7 +75,7 @@
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+add_module_names = False
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.

diff --git a/doc/stdlib/index.rst b/doc/stdlib/index.rst
@@ -8,8 +8,21 @@
 :Release: |version|
 :Date: |today|
 
+*********
+Built-ins
+*********
+
 .. toctree::
    :maxdepth: 1
 
    base
 
+******
+Extras
+******
+
+.. toctree::
+   :maxdepth: 1
+
+   specfun
+
diff --git a/doc/stdlib/specfun.rst b/doc/stdlib/specfun.rst
@@ -0,0 +1,46 @@
+:mod:`specfun.jl` --- Special mathematical functions
+====================================================
+
+.. module:: specfun.jl
+   :synopsis: Special mathematical functions.
+
+.. function:: besselj0(x)
+
+   Bessel function of the first kind of order 0, :math:`J_0(x)`.
+
+.. function:: besselj1(x)
+
+   Bessel function of the first kind of order 1, :math:`J_1(x)`.
+
+.. function:: besselj(nu, x)
+
+   Bessel function of the first kind of order ``nu``, :math:`J_\nu(x)`.
+
+.. function:: bessely0(x)
+
+   Bessel function of the second kind of order 0, :math:`Y_0(x)`.
+
+.. function:: bessely1(x)
+
+   Bessel function of the second kind of order 1, :math:`Y_1(x)`.
+
+.. function:: bessely(nu, x)
+
+   Bessel function of the second kind of order ``nu``, :math:`Y_\nu(x)`.
+
+.. function:: hankelh1(nu, x)
+
+   Bessel function of the third kind of order ``nu``, :math:`H^{(1)}_\nu(x)`.
+
+.. function:: hankelh2(nu, x)
+
+   Bessel function of the third kind of order ``nu``, :math:`H^{(2)}_\nu(x)`.
+
+.. function:: besseli(nu, x)
+
+   Modified Bessel function of the first kind of order ``nu``, :math:`I_\nu(x)`.
+
+.. function:: besselk(nu, x)
+
+   Modified Bessel function of the second kind of order ``nu``, :math:`K_\nu(x)`.
+