many placeholder for test/scripts/doc/...

README.md

@@ -1,2 +1,4 @@
-# silx
+
 ScIentific Library for eXperimentalists
+=======================================
+

bootstrap.py

@@ -0,0 +1,128 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""
+Bootstrap helps you to test scripts without installing them
+by patching your PYTHONPATH on the fly
+
+example: ./bootstrap.py ipython
+"""
+
+__authors__ = ["Frédéric-Emmanuel Picca", "Jérôme Kieffer"]
+__contact__ = "[email protected]"
+__license__ = "MIT"
+__date__ = "27/11/2015"
+
+
+import sys
+import os
+import shutil
+import distutils.util
+import subprocess
+
+
+TARGET = os.path.basename(os.path.dirname(os.path.abspath(__file__))).split("-")[0]
+
+
+def _copy(infile, outfile):
+    "link or copy file according to the OS. Nota those are HARD_LINKS"
+    if "link" in dir(os):
+        os.link(infile, outfile)
+    else:
+        shutil.copy(infile, outfile)
+
+
+def _distutils_dir_name(dname="lib"):
+    """
+    Returns the name of a distutils build directory
+    """
+    platform = distutils.util.get_platform()
+    architecture = "%s.%s-%i.%i" % (dname, platform,
+                                    sys.version_info[0], sys.version_info[1])
+    return architecture
+
+
+def _distutils_scripts_name():
+    """Return the name of the distrutils scripts sirectory"""
+    f = "scripts-{version[0]}.{version[1]}"
+    return f.format(version=sys.version_info)
+
+
+def _get_available_scripts(path):
+    res = []
+    try:
+        res = " ".join([s.rstrip('.py') for s in os.listdir(path)])
+    except OSError:
+        res = ["no script available, did you ran "
+               "'python setup.py build' before bootstrapping ?"]
+    return res
+
+
+def _copy_files(source, dest, extn):
+    """
+    copy all files with a given extension from source to destination
+    """
+    if not os.path.isdir(dest):
+        os.makedirs(dest)
+    full_src = os.path.join(os.path.dirname(__file__), source)
+    for clf in os.listdir(full_src):
+        if clf.endswith(extn) and clf not in os.listdir(dest):
+            _copy(os.path.join(full_src, clf), os.path.join(dest, clf))
+
+
+def runfile(fname):
+    try:
+        execfile(fname)
+    except SyntaxError:
+        env = os.environ.copy()
+        env.update({"PYTHONPATH": LIBPATH + os.pathsep + os.environ.get("PYTHONPATH", ""),
+                    "PATH": SCRIPTSPATH + os.pathsep + os.environ.get("PATH", "")})
+        run = subprocess.Popen(sys.argv, shell=False, env=env)
+        run.wait()
+
+home = os.path.dirname(os.path.abspath(__file__))
+SCRIPTSPATH = os.path.join(home,
+                           'build', _distutils_scripts_name())
+LIBPATH = (os.path.join(home,
+                       'build', _distutils_dir_name('lib')))
+
+if (not os.path.isdir(SCRIPTSPATH)) or (not os.path.isdir(LIBPATH)):
+    build = subprocess.Popen([sys.executable, "setup.py", "build"],
+                     shell=False, cwd=os.path.dirname(__file__))
+    print("Build process ended with rc= %s" % build.wait())
+# _copy_files("openCL", os.path.join(LIBPATH, TARGET, "openCL"), ".cl")
+# _copy_files("gui", os.path.join(LIBPATH, TARGET, "gui"), ".ui")
+# _copy_files("calibration", os.path.join(LIBPATH, TARGET, "calibration"), ".D")
+
+if __name__ == "__main__":
+    if len(sys.argv) < 2:
+        print("usage: ./bootstrap.py <script>\n")
+        print("Available scripts : %s\n" %
+              _get_available_scripts(SCRIPTSPATH))
+        sys.exit(1)
+    os.system("cd %s;python setup.py build; cd -" % home)
+    print("Executing %s from source checkout" % (sys.argv[1]))
+
+    sys.path.insert(0, LIBPATH)
+    print("01. Patched sys.path with %s" % LIBPATH)
+
+    sys.path.insert(0, SCRIPTSPATH)
+    print("02. Patched sys.path with %s" % SCRIPTSPATH)
+
+    script = sys.argv[1]
+    sys.argv = sys.argv[1:]
+    print("03. patch the sys.argv : ", sys.argv)
+
+    print("04. Executing %s.main()" % (script,))
+    fullpath = os.path.join(SCRIPTSPATH, script)
+    if os.path.exists(fullpath):
+        runfile(fullpath)
+    else:
+        if os.path.exists(script):
+            runfile(script)
+        else:
+            for dirname in os.environ.get("PATH", "").split(os.pathsep):
+                fullpath = os.path.join(dirname, script)
+                if os.path.exists(fullpath):
+                    runfile(fullpath)
+                    break
+

doc/Makefile

@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# 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
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@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 "  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 "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/silx.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/silx.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/silx"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/silx"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."