Init sphinx build and split manual for it.

.gitignore

@@ -66,6 +66,7 @@ tests/old_suite/basic/test_pyz_as_external_file.exe.pkg
 # /doc/
 /doc/source/_definitions.txt
 /doc/source/_pyi*.tmp
+/doc/_build
 
 # Bootloader source
 /bootloader/.lock-waf*

doc/CHANGES.rst

@@ -500,3 +500,9 @@ Fixed the following issues:
 - Restyle documentation (now using docutils and reStructuredText).
 - New Windows build system for automatic compilations of bootloader in all
   the required flavours (using Scons)
+
+.. Emacs config:
+ Local Variables:
+ mode: rst
+ ispell-local-dictionary: "american"
+ End:

doc/CREDITS.rst

@@ -143,3 +143,9 @@ Contributions to PyInstaller 2.1 and older
 - Eugene Prigorodov <eprigorodov at naumen dot ru> - KInterasDB import hook.
 - David C. Morrill - vtkpython import hook.
 - Alan James Salmoni - Tkinter interface to PyInstaller.
+
+.. Emacs config:
+ Local Variables:
+ mode: rst
+ ispell-local-dictionary: "american"
+ End:

doc/Makefile

@@ -0,0 +1,192 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# 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
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage 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 "  applehelp  to make an Apple Help Book"
+	@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 "  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)"
+	@echo "  coverage   to run coverage check of 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/PyInstaller.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PyInstaller.qhc"
+
+applehelp:
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+	@echo
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+	@echo "N.B. You won't be able to view it unless you put it in" \
+	      "~/Library/Documentation/Help or install it in your application" \
+	      "bundle."
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/PyInstaller"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PyInstaller"
+	@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."
+
+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
+	@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."
+
+coverage:
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+	@echo "Testing of coverage in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/coverage/python.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

doc/_common_definitions.txt

@@ -0,0 +1,77 @@
+.. include:: _definitions.txt
+
+.. _`activation context`: http://msdn.microsoft.com/en-us/library/windows/desktop/aa374153(v=vs.85).aspx
+.. _`Apple bundle overview`: https://developer.apple.com/library/mac/documentation/CoreFoundation/Conceptual/CFBundles/BundleTypes/BundleTypes.html
+.. _`Apple code signing overview`: https://developer.apple.com/library/mac/technotes/tn2206/_index.html
+.. _`Apple document types`: https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-101685
+.. _Cython: http://www.cython.org/
+.. _Django: https://www.djangoproject.com/
+.. _dnspython: http://www.dnspython.org/
+.. _Dropbox: https://www.dropbox.com/home
+.. _`easy_install`: http://peak.telecommunity.com/DevCenter/EasyInstall
+.. _`Microsoft COM`: http://www.microsoft.com/com/default.mspx
+.. _`GPL License`: https://raw.github.com/pyinstaller/pyinstaller/develop/COPYING.txt
+.. _FAQ: https://github.com/pyinstaller/pyinstaller/wiki/FAQ
+.. _Git: http://git-scm.com/downloads
+.. _GraphicConverter: http://www.lemkesoft.de/en/products/graphic-converter/
+.. _GraphViz: http://graphviz.org/Home.php
+.. _Homebrew: http://brew.sh/
+.. _`How to Contribute`: https://github.com/pyinstaller/pyinstaller/wiki/How-to-Contribute
+.. _`How to Report Bugs`: https://github.com/pyinstaller/pyinstaller/wiki/How-to-Report-Bugs
+.. _ImageMagick: http://www.imagemagick.org/script/index.php
+.. _imputil: http://docs.python.org/2.7/library/imputil.html
+.. _`Info Property List`: https://developer.apple.com/library/mac/#documentation/MacOSX/Conceptual/BPRuntimeConfig/Articles/ConfigFiles.html
+.. _`LSB sdk 4.0`: http://ftp.linuxfoundation.org/pub/lsb/bundles/released-4.0.0/sdk/
+.. _MacPorts: https://www.macports.org/
+.. _makeicns: https://bitbucket.org/mkae/makeicns
+.. _marshalled: http://docs.python.org/library/marshal
+.. _MinGW: http://sourceforge.net/downloads/mingw/
+.. _MinGW-w64: http://mingw-w64.sourceforge.net/
+.. _Modulefinder: http://docs.python.org/2.7/library/modulefinder.html
+.. _netpbm package: http://netpbm.sourceforge.net/
+.. _Parallels: http://www.parallels.com/
+.. _`PEP 302`: http://www.python.org/dev/peps/pep-0302/
+.. _PIL: http://www.pythonware.com/products/pil/
+.. _pip: http://www.pip-installer.org/
+.. _pip-Win: https://sites.google.com/site/pydatalog/python/pip-for-windows
+.. _png2icns: http://icns.sourceforge.net/
+.. _PyCrypto: https://pypi.python.org/pypi/pycrypto/
+.. _PyInstaller.org: https://github.com/pyinstaller/pyinstaller/wiki/Community
+.. _`PyInstaller at GitHub`: https://github.com/pyinstaller/pyinstaller
+.. _`PyInstaller code signing recipe`: https://github.com/pyinstaller/pyinstaller/wiki/Recipe-OSX-Code-Signing
+.. _`PyInstaller Downloads`:  https://github.com/pyinstaller/pyinstaller/releases
+.. _PyInstaller\/hooks\/hook-win32com.py: http://www.pyinstaller.org/browser/trunk/PyInstaller/hooks/hook-win32com.py?rev=latest
+.. _`PyInstaller Email List`: https://groups.google.com/forum/#!forum/pyinstaller
+.. _`PyInstaller Issue #1309`: https://github.com/pyinstaller/pyinstaller/issues/1309
+.. _`PyInstaller Issue #1527`: https://github.com/pyinstaller/pyinstaller/issues/1527
+.. _`PyInstaller Recipes`: https://github.com/pyinstaller/pyinstaller/wiki/Recipes
+.. _pypi: https://pypi.python.org/pypi/PyInstaller/
+.. _pypiwin32: https://pypi.python.org/pypi/pypiwin32/219
+.. _PyQt: http://www.riverbankcomputing.co.uk/software/pyqt/intro
+.. _PySide: http://qt-project.org/wiki/About-PySide
+.. _pyvenv: https://docs.python.org/3.4/library/venv.html
+.. _PyWin32: http://sourceforge.net/projects/pywin32/files/
+.. _Qt: http://www.qt-project.org
+.. _Recipe: http://www.pyinstaller.org/wiki/Recipe
+.. _setup_tools: https://pypi.python.org/pypi/setuptools
+.. _`Package resources`: https://pythonhosted.org/setuptools/pkg_resources.html#requirements-parsing
+.. _source/common/launch.c: http://www.pyinstaller.org/browser/trunk/source/common/launch.c?rev=latest
+.. _`Supported Packages`: https://github.com/pyinstaller/pyinstaller/wiki/Supported-Packages
+.. _TDM-GCC: http://tdm-gcc.tdragon.net/
+.. _TkInter: http://wiki.python.org/moin/TkInter
+.. _UPX: http://upx.sourceforge.net/
+.. _virtualenv:  http://www.virtualenv.org/
+.. _`Visual Studio Express`: http://www.microsoft.com/express/
+.. _wiki: http://www.pyinstaller.org/wiki
+.. _`Version Information Structures`: http://msdn.microsoft.com/en-us/library/ff468916(v=vs.85).aspx
+.. _virtualBox: https://www.virtualbox.org
+.. _VMWare: http://www.vmware.com/solutions/desktop/
+.. _Wine: http://www.winehq.org/
+.. _WxPython: http://www.wxpython.org/
+.. _Xcode: http://developer.apple.com/xcode
+
+.. Emacs config:
+ Local Variables:
+ mode: rst
+ ispell-local-dictionary: "american"
+ End:

doc/_definitions.txt

@@ -0,0 +1,15 @@
+.. _PyInstaller: http://www.pyinstaller.org
+
+.. |Homepage| replace:: http://www.pyinstaller.org
+.. |PyInstaller| replace:: `PyInstaller`
+.. |Version| replace:: 3.1
+.. |PyInstallerVersion| replace:: PyInstaller |Version|
+.. |unzipped_download| replace:: ``pyinstaller``
+.. |bootloader| replace:: bootloader
+
+
+.. Emacs config:
+ Local Variables:
+ mode: rst
+ ispell-local-dictionary: "american"
+ End: