* Adding support files for building Sphinx documentation

doc_src/build_autodoc_files.py

@@ -0,0 +1,87 @@
+"Build up the sphinx autodoc file for the python code"
+
+import os
+
+pywin_folder = os.path.split(__file__)[0]
+pywin_folder = os.path.split(pywin_folder)[0]
+
+import sys
+sys.path.append(pywin_folder)
+pywin_folder = os.path.join(pywin_folder, "pywinauto")
+
+excluded_dirs = ["unittests"]
+excluded_files = [
+    "_menux.py", 
+    "__init__.py", 
+    "win32defines.py", 
+    "win32structures.py", 
+    "win32functions.py"]
+
+output_folder = "code"
+
+try:
+    os.mkdir(output_folder)
+except WindowsError:
+    pass
+
+module_docs = []
+for root, dirs, files in os.walk(pywin_folder):
+
+    # Skip over directories we don't want to document
+    for i, d in enumerate(dirs):
+        if d in excluded_dirs:
+            del dirs[i]
+
+    py_files = [f for f in files if f.endswith(".py")]
+    
+    # skip over py files we don't want to document
+    for filename in py_files:
+        if filename in excluded_files:
+            continue
+        
+        doc_source_filename = os.path.join(
+            output_folder, filename + ".txt")
+        if os.path.exists(doc_source_filename):
+            continue
+        
+        print filename
+        
+        filepath =  os.path.join(root, filename)
+                
+        modulename = filepath.split("\\")
+        modulename = modulename[modulename.index('pywinauto'):]
+
+        # remove extension
+        modulename[-1] = modulename[-1][:-3]
+        
+        modulename = ".".join(modulename)
+        
+        out = open(doc_source_filename, "w")
+        
+        out.write(modulename + "\n")
+        out.write("-" * len(modulename) + "\n")
+        out.write(" .. automodule:: %s\n"% modulename)
+        out.write("    :members:\n")
+        out.write("    :undoc-members:\n\n")
+        #out.write("    :inherited-members:\n")
+        #out.write(" .. autoattribute:: %s\n"% modulename)
+        out.close()
+        
+        module_docs.append(doc_source_filename)
+
+
+# This section needs to be updated - I should idealy parse the 
+# existing file to see if any new docs have been added, if not then
+# I should just leave the file alone rathre than re-create.
+#
+#c = open(os.path.join(output_folder, "code.txt"), "w")
+#c.write("Source Code\n")
+#c.write("=" * 30 + "\n")
+#
+#c.write(".. toctree::\n")
+#c.write("   :maxdepth: 3\n\n")
+#for doc in module_docs:
+#    c.write("   " + doc + "\n")
+#    
+#c.close()
+#        

doc_src/code/HwndWrapper.py.txt

@@ -0,0 +1,6 @@
+pywinauto.controls.HwndWrapper
+------------------------------
+ .. automodule:: pywinauto.controls.HwndWrapper
+    :members:
+    :undoc-members:
+

doc_src/code/XMLHelpers.py.txt

@@ -0,0 +1,6 @@
+pywinauto.XMLHelpers
+--------------------
+ .. automodule:: pywinauto.XMLHelpers
+    :members:
+    :undoc-members:
+

doc_src/code/allcontrols.py.txt

@@ -0,0 +1,6 @@
+pywinauto.tests.allcontrols
+---------------------------
+ .. automodule:: pywinauto.tests.allcontrols
+    :members:
+    :undoc-members:
+

doc_src/code/application.py.txt

@@ -0,0 +1,14 @@
+pywinauto.application
+---------------------
+
+ .. automodule:: pywinauto.application
+    :members: Application, AppNotConnected, AppStartError, AssertValidProcess, ProcessNotFoundError, process_from_module, process_module
+    :undoc-members:
+    :show-inheritance:
+   
+ .. autoclass:: pywinauto.application.WindowSpecification
+    :members:
+    
+    .. automethod:: pywinauto.application.WindowSpecification.__getitem__
+    .. automethod:: pywinauto.application.WindowSpecification.__getattr__
+

doc_src/code/asianhotkey.py.txt

@@ -0,0 +1,6 @@
+pywinauto.tests.asianhotkey
+---------------------------
+ .. automodule:: pywinauto.tests.asianhotkey
+    :members:
+    :undoc-members:
+

doc_src/code/changedtext.py.txt

@@ -0,0 +1,6 @@
+pywinauto.tests.changedtext
+---------------------------
+ .. automodule:: pywinauto.tests.changedtext
+    :members:
+    :undoc-members:
+

doc_src/code/clipboard.py.txt

@@ -0,0 +1,6 @@
+pywinauto.clipboard
+-------------------
+ .. automodule:: pywinauto.clipboard
+    :members:
+    :undoc-members:
+

doc_src/code/code.txt

@@ -0,0 +1,32 @@
+Source Code
+==============================
+.. toctree::
+   :maxdepth: 3
+
+   allcontrols.py.txt
+   application.py.txt
+   asianhotkey.py.txt
+   changedtext.py.txt
+   clipboard.py.txt
+   comboboxdroppedheight.py.txt
+   common_controls.py.txt
+   comparetoreffont.py.txt
+   findbestmatch.py.txt
+   findwindows.py.txt
+   fuzzydict.py.txt
+   handleprops.py.txt
+   HwndWrapper.py.txt
+   leadtrailspaces.py.txt
+   menuwrapper.py.txt
+   miscvalues.py.txt
+   missalignmen2t.py.txt
+   missalignment.py.txt
+   missingextrastring.py.txt
+   overlapping.py.txt
+   repeatedhotkey.py.txt
+   taskbar.py.txt
+   timings.py.txt
+   translation.py.txt
+   truncation.py.txt
+   win32_controls.py.txt
+   XMLHelpers.py.txt

doc_src/code/comboboxdroppedheight.py.txt

@@ -0,0 +1,6 @@
+pywinauto.tests.comboboxdroppedheight
+-------------------------------------
+ .. automodule:: pywinauto.tests.comboboxdroppedheight
+    :members:
+    :undoc-members:
+

doc_src/code/common_controls.py.txt

@@ -0,0 +1,6 @@
+pywinauto.controls.common_controls
+----------------------------------
+ .. automodule:: pywinauto.controls.common_controls
+    :members:
+    :undoc-members:
+

doc_src/code/comparetoreffont.py.txt

@@ -0,0 +1,6 @@
+pywinauto.tests.comparetoreffont
+--------------------------------
+ .. automodule:: pywinauto.tests.comparetoreffont
+    :members:
+    :undoc-members:
+

doc_src/code/findbestmatch.py.txt

@@ -0,0 +1,6 @@
+pywinauto.findbestmatch
+-----------------------
+ .. automodule:: pywinauto.findbestmatch
+    :members:
+    :undoc-members:
+

doc_src/code/findwindows.py.txt

@@ -0,0 +1,6 @@
+pywinauto.findwindows
+---------------------
+ .. automodule:: pywinauto.findwindows
+    :members:
+    :undoc-members:
+

doc_src/code/fuzzydict.py.txt

@@ -0,0 +1,6 @@
+pywinauto.fuzzydict
+-------------------
+ .. automodule:: pywinauto.fuzzydict
+    :members:
+    :undoc-members:
+

doc_src/code/handleprops.py.txt

@@ -0,0 +1,6 @@
+pywinauto.handleprops
+---------------------
+ .. automodule:: pywinauto.handleprops
+    :members:
+    :undoc-members:
+

doc_src/code/leadtrailspaces.py.txt

@@ -0,0 +1,6 @@
+pywinauto.tests.leadtrailspaces
+-------------------------------
+ .. automodule:: pywinauto.tests.leadtrailspaces
+    :members:
+    :undoc-members:
+

doc_src/code/menuwrapper.py.txt

@@ -0,0 +1,6 @@
+pywinauto.controls.menuwrapper
+------------------------------
+ .. automodule:: pywinauto.controls.menuwrapper
+    :members:
+    :undoc-members:
+

doc_src/code/miscvalues.py.txt

@@ -0,0 +1,6 @@
+pywinauto.tests.miscvalues
+--------------------------
+ .. automodule:: pywinauto.tests.miscvalues
+    :members:
+    :undoc-members:
+

doc_src/code/missalignmen2t.py.txt

@@ -0,0 +1,6 @@
+pywinauto.tests.missalignmen2t
+------------------------------
+ .. automodule:: pywinauto.tests.missalignmen2t
+    :members:
+    :undoc-members:
+

doc_src/code/missalignment.py.txt

@@ -0,0 +1,6 @@
+pywinauto.tests.missalignment
+-----------------------------
+ .. automodule:: pywinauto.tests.missalignment
+    :members:
+    :undoc-members:
+

doc_src/code/missingextrastring.py.txt

@@ -0,0 +1,6 @@
+pywinauto.tests.missingextrastring
+----------------------------------
+ .. automodule:: pywinauto.tests.missingextrastring
+    :members:
+    :undoc-members:
+

doc_src/code/overlapping.py.txt

@@ -0,0 +1,6 @@
+pywinauto.tests.overlapping
+---------------------------
+ .. automodule:: pywinauto.tests.overlapping
+    :members:
+    :undoc-members:
+

doc_src/code/repeatedhotkey.py.txt

@@ -0,0 +1,6 @@
+pywinauto.tests.repeatedhotkey
+------------------------------
+ .. automodule:: pywinauto.tests.repeatedhotkey
+    :members:
+    :undoc-members:
+

doc_src/code/taskbar.py.txt

@@ -0,0 +1,6 @@
+pywinauto.taskbar
+-----------------
+ .. automodule:: pywinauto.taskbar
+    :members:
+    :undoc-members:
+

doc_src/code/timings.py.txt

@@ -0,0 +1,6 @@
+pywinauto.timings
+-----------------
+ .. automodule:: pywinauto.timings
+    :members:
+    :undoc-members:
+

doc_src/code/translation.py.txt

@@ -0,0 +1,6 @@
+pywinauto.tests.translation
+---------------------------
+ .. automodule:: pywinauto.tests.translation
+    :members:
+    :undoc-members:
+

doc_src/code/truncation.py.txt

@@ -0,0 +1,6 @@
+pywinauto.tests.truncation
+--------------------------
+ .. automodule:: pywinauto.tests.truncation
+    :members:
+    :undoc-members:
+

doc_src/code/win32_controls.py.txt

@@ -0,0 +1,6 @@
+pywinauto.controls.win32_controls
+---------------------------------
+ .. automodule:: pywinauto.controls.win32_controls
+    :members:
+    :undoc-members:
+

doc_src/conf.py

@@ -0,0 +1,196 @@
+# -*- coding: utf-8 -*-
+#
+# pywinauto documentation build configuration file, created by
+# sphinx-quickstart on Mon Mar 02 22:29:19 2009.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# The contents of this file are pickled, so don't put values in the namespace
+# that aren't pickleable (module imports are okay, they're removed automatically).
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+sys.path.append("..")
+sys.path.append(".")
+
+# If your extensions are in another directory, add it here. If the directory
+# is relative to the documentation root, use os.path.abspath to make it
+# absolute, like shown here.
+sys.path.append(os.path.abspath('.'))
+
+# General configuration
+# ---------------------
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc',]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['.templates']
+
+# The suffix of source filenames.
+source_suffix = '.txt'
+
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'contents'
+
+# General information about the project.
+project = u'pywinauto'
+copyright = u'2009, Mark Mc Mahon'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.3.8'
+# The full version, including alpha/beta/rc tags.
+release = '0.3.8'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = ['.build', "examples", "dist", r"pywinauto\unittests", "pywinauto_wait_branch"]
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# Options for HTML output
+# -----------------------
+
+# The style sheet to use for HTML and HTML Help pages. A file of that name
+# must exist either in Sphinx' static/ path, or in one of the custom paths
+# given in html_static_path.
+html_style = 'default.css'
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['.static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_use_modindex = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, the reST sources are included in the HTML build as _sources/<name>.
+#html_copy_source = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'pywinautodoc'
+
+
+# Options for LaTeX output
+# ------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, document class [howto/manual]).
+latex_documents = [
+  ('index', 'pywinauto.tex', ur'pywinauto Documentation',
+   ur'Mark Mc Mahon', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True
+
+
+# parameter to autodoc to make it take the doc from the __init__ methods also
+autoclass_content = 'both'

doc_src/contents.txt

@@ -0,0 +1,37 @@
+.. pywinauto documentation master file, created by sphinx-quickstart on Wed Apr 02 15:09:06 2008.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to pywinauto's documentation!
+=====================================
+
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+   
+   about
+   index
+   HISTORY
+   HowTo
+   controls_overview
+   credits
+   getting_started
+
+   code/code
+   dev_notes
+   TODO
+
+
+
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+