skpkg: migrate docs/source files

doc/manual/Makefile → docs/Makefile

@@ -6,6 +6,12 @@ SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = build
+BASENAME      = $(subst .,,$(subst $() $(),,diffpy.srxplanar))
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
 
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
@@ -14,7 +20,7 @@ ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) sou
 # the i18n builder cannot share the environment and doctrees with the others
 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
 
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext publish
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
 
 help:
 	@echo "Please use \`make <target>' where <target> is one of"
@@ -29,17 +35,20 @@ help:
 	@echo "  epub       to make an epub"
 	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
 	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
 	@echo "  text       to make text files"
 	@echo "  man        to make manual pages"
 	@echo "  texinfo    to make Texinfo files"
 	@echo "  info       to make Texinfo files and run them through makeinfo"
 	@echo "  gettext    to make PO message catalogs"
 	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
 	@echo "  linkcheck  to check all external links for integrity"
 	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
 
 clean:
-	-rm -rf $(BUILDDIR)/*
+	rm -rf $(BUILDDIR)/*
 
 html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@@ -77,17 +86,17 @@ qthelp:
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Structure.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/$(BASENAME).qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Structure.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/$(BASENAME).qhc"
 
 devhelp:
 	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 	@echo
 	@echo "Build finished."
 	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/Structure"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Structure"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/$(BASENAME)"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/$(BASENAME)"
 	@echo "# devhelp"
 
 epub:
@@ -108,6 +117,12 @@ latexpdf:
 	$(MAKE) -C $(BUILDDIR)/latex all-pdf
 	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
 text:
 	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
 	@echo

doc/examples/fit2d.txt → docs/examples/fit2d.txt

@@ -1,14 +1,14 @@
-INFO: Number of function calls =       7
-INFO: Sum of squares =     2.3219
-INFO: Number of rejected coordinates =     0
-INFO: Number of function calls =       7
-INFO: Sum of squares =     2.3219
-INFO: Refined Beam centre =      1299.430      1010.190 (pixels)
-INFO: Refined Beam centre =      186.240       1.299 (mm)
-INFO: Refined sample to detector distance =      369.579 mm
-INFO: Refined wavelength =      0.1078 Angstroms
-      Energy (keV) =     115.0
-INFO: Refined tilt plane rotation angle =      49.715 degrees
-INFO: Refined tilt angle =        -1.480 degrees
-INFO: ROT X =        0.068   ROT Y =       -0.425 degrees
-INFO: Stability indicator (proportional to D-spacing; Angstroms) =    0.46505
+INFO: Number of function calls =       7
+INFO: Sum of squares =     2.3219
+INFO: Number of rejected coordinates =     0
+INFO: Number of function calls =       7
+INFO: Sum of squares =     2.3219
+INFO: Refined Beam centre =      1299.430      1010.190 (pixels)
+INFO: Refined Beam centre =      186.240       1.299 (mm)
+INFO: Refined sample to detector distance =      369.579 mm
+INFO: Refined wavelength =      0.1078 Angstroms
+      Energy (keV) =     115.0
+INFO: Refined tilt plane rotation angle =      49.715 degrees
+INFO: Refined tilt angle =        -1.480 degrees
+INFO: ROT X =        0.068   ROT Y =       -0.425 degrees
+INFO: Stability indicator (proportional to D-spacing; Angstroms) =    0.46505

docs/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+set SPHINXPROJ=PackagingScientificPython
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

doc/manual/source/api/diffpy.confutils.rst → docs/source/api/diffpy.confutils.rst

@@ -1,32 +1,32 @@
 confutils Package
 =================
 
-:mod:`confutils` Package
-------------------------
+:mod:`diffpy.confutils` Package
+-------------------------------
 
 .. automodule:: diffpy.confutils
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`config` Module
---------------------
+:mod:`diffpy.confutils.config` Module
+-------------------------------------
 
 .. automodule:: diffpy.confutils.config
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`tools` Module
--------------------
+:mod:`diffpy.confutils.tools` Module
+------------------------------------
 
 .. automodule:: diffpy.confutils.tools
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`version` Module
----------------------
+:mod:`diffpy.confutils.version` Module
+--------------------------------------
 
 .. automodule:: diffpy.confutils.version
     :members:

doc/manual/source/api/diffpy.srxplanar.rst → docs/source/api/diffpy.srxplanar.rst

@@ -1,64 +1,82 @@
-srxplanar Package
-=================
+:tocdepth: -1
 
-:mod:`srxplanar` Package
-------------------------
+|title|
+=======
+
+.. |title| replace:: diffpy.srxplanar package
 
 .. automodule:: diffpy.srxplanar
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`calculate` Module
------------------------
+Submodules
+---------------------
+
+|module_1|
+----------
+
+.. |module_1| replace:: diffpy.srxplanar.calculate module
 
 .. automodule:: diffpy.srxplanar.calculate
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`loadimage` Module
------------------------
+|module_2|
+----------
+
+.. |module_2| replace:: diffpy.srxplanar.loadimage module
 
 .. automodule:: diffpy.srxplanar.loadimage
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`mask` Module
-------------------
+|module_3|
+----------
+
+.. |module_3| replace:: diffpy.srxplanar.mask module
 
 .. automodule:: diffpy.srxplanar.mask
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`saveresults` Module
--------------------------
+|module_4|
+----------
+
+.. |module_4| replace:: diffpy.srxplanar.saveresults module
 
 .. automodule:: diffpy.srxplanar.saveresults
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`srxplanar` Module
------------------------
+|module_5|
+----------
+
+.. |module_5| replace:: diffpy.srxplanar.srxplanar module
 
 .. automodule:: diffpy.srxplanar.srxplanar
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`srxplanarconfig` Module
------------------------------
+|module_6|
+----------
+
+.. |module_6| replace:: diffpy.srxplanar.srxplanarconfig module
 
 .. automodule:: diffpy.srxplanar.srxplanarconfig
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`version` Module
----------------------
+|module_7|
+----------
+
+.. |module_7| replace:: diffpy.srxplanar.version module
 
 .. automodule:: diffpy.srxplanar.version
     :members: