add function of spelling check for making documentation

SpM-lab · Mar 24, 2018 · 278e249 · 278e249
1 parent 1f27450
commit 278e249
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 6 deletions.
diff --git a/docs/manual/source/Makefile b/docs/manual/source/Makefile
@@ -52,6 +52,7 @@ clean:
 
 .PHONY: html
 html:
+	$(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/spelling
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

diff --git a/docs/manual/source/conf.py b/docs/manual/source/conf.py
@@ -37,7 +37,9 @@
               'sphinxcontrib.actdiag',
               'sphinxcontrib.nwdiag',
               'sphinxcontrib.rackdiag',
-              'sphinxcontrib.packetdiag',]
+              'sphinxcontrib.packetdiag',
+              'sphinxcontrib.spelling',]
+
 #mathjax_path = 'http://mathjax.connectmv.com/MathJax.js?config=default'
 
 blockdiag_html_image_format = 'SVG'

diff --git a/docs/manual/source/docs/inputfile.rst b/docs/manual/source/docs/inputfile.rst
@@ -7,7 +7,7 @@
 
 Input files
 ===============================
-1. Paramete file (param.in)
+1. Parameter file (param.in)
 
 The variables for which default value is not given are mandatory.
 
@@ -47,7 +47,7 @@ The variables for which default value is not given are mandatory.
      :widths: 1,1,2,4
 
      Name, Type, Default value, Description
-     SVmin, Double, 1e-10, Truncation value of singlular values.
+     SVmin, Double, 1e-10, Truncation value of singiular values.
 
 
 * ADMM
@@ -62,7 +62,7 @@ The variables for which default value is not given are mandatory.
      lambdalogend, Double, -1, The log value of minimum lambda. lambda_min is given by :math:`10^{\verb|lambdalogend|}`
      Nlambda, Integer, ---,  The number of lambda to be calculated.
      penalty, Double, 10.0, "The value of penalty coefficient. If negative, penalty is optimized during the iteration starting with its absolute value."
-     tolerance, Double, 1e-6, The criteria of convergience.
+     tolerance, Double, 1e-6, The criteria of convergence.
      maxiteration, Integer,1000,	The maximum number of iterations.
      printlevel, Integer,2,	"0; minimum, 1; moderate, 2; verbose."
 
@@ -71,4 +71,4 @@ The variables for which default value is not given are mandatory.
    In SPM, the values of Green's function is only used for calculation,
    i.e. tau is automatically determined by the beta and the step.
    Please indicate the column number where the values of G(tau) are
-   stored by "column" in the prameter file.
+   stored by "column" in the parameter file.
diff --git a/docs/manual/source/docs/tutorials.rst b/docs/manual/source/docs/tutorials.rst
@@ -150,7 +150,7 @@ Let us look at some graphs below.
 
 - *find_lambda_opt.eps*
 
-    User should check how the regularization parameter :math:`\lambda` is determined and whether the choice is resonable.
+    User should check how the regularization parameter :math:`\lambda` is determined and whether the choice is reasonable.
     Loot at the file ``output/find_lambda_opt.eps``
 
     .. image:: figs/find_lambda_opt.jpg

diff --git a/docs/manual/source/spelling_wordlist.txt b/docs/manual/source/spelling_wordlist.txt
@@ -0,0 +1,34 @@
+Yoshimi
+SVmin
+spm
+SpM
+Shinaoka
+printlevel
+param
+Otsuki
+omegamin
+omegamax
+Ohzeki
+nonnegativity
+NOmega
+Nomega
+Nlambda
+nd
+NaN
+maxiteration
+lambdalogmesh
+lambdalogend
+lambdalogbegin
+Gtau
+Gnuplot
+gnuplot
+fileout
+filein
+fermionic
+documantation
+dep
+dat
+cpplapack
+cpp
+cmake
+bosonic