Added a sphinx python API page.

docs/docs/main_menu.xml

@@ -98,6 +98,10 @@
             <link>intro.html</link>
             <chm_sub>intro.xml</chm_sub>
          </item>
+         <item>
+            <name>Python API</name>
+            <link>python/index.html</link>
+         </item>
          <item>
             <name>How to compile</name>
             <link>compile.html</link>

docs/docs/python/conf.py

@@ -0,0 +1,246 @@
+# -*- coding: utf-8 -*-
+#
+# dlib documentation build configuration file, created by
+# sphinx-quickstart on Wed Jun 12 18:29:29 2013.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# 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
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('../../../python_examples'))
+
+import generate_dlib_listing
+generate_dlib_listing.make_listing_files()
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# 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 = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'dlib'
+copyright = u'2013, Davis E. King'
+
+# 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 = '18.3'
+# The full version, including alpha/beta/rc tags.
+#release = '18.3'
+
+# 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 patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# 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'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# 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_domain_indices = 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, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = 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 = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'dlibdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'dlib.tex', u'dlib Documentation',
+   u'Davis', '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
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'dlib', u'dlib Documentation',
+     [u'Davis'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'dlib', u'dlib Documentation',
+   u'Davis', 'dlib', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'

docs/docs/python/generate_dlib_listing.py

@@ -0,0 +1,19 @@
+from __future__ import print_function
+import dlib
+import inspect
+
+def make_listing_files():
+
+    fc = open('classes.txt', 'w')
+    ff = open('functions.txt', 'w')
+
+    for obj in dir(dlib):
+        if obj[0] == '_':
+            continue
+        name = 'dlib.'+obj
+        isclass = inspect.isclass(eval(name))
+        if (isclass):
+            print("* :class:`{}`".format(name), file=fc)
+        else:
+            print("* :func:`{}`".format(name), file=ff)
+

docs/docs/python/index.rst

@@ -0,0 +1,37 @@
+
+=========================
+
+.. image:: ../dlib-logo.png
+   :alt: Dlib C++ Library 
+   :target: http://dlib.net
+
+Dlib is principally a C++ library, however, you can use a number of its tools
+from python applications.  This page documents the python API for working with
+these dlib tools.  If you haven't done so already, you should probably look at
+the python example programs first before consulting this reference.  These
+example programs are little mini-tutorials for using dlib from python.  They
+are listed on the left of the main dlib web page.
+
+Classes
+==============================================
+
+.. include:: classes.txt
+
+Functions
+==============================================
+
+.. include:: functions.txt
+
+
+Detailed API Listing
+==============================================
+
+.. toctree::
+   :maxdepth: 2
+
+.. automodule:: dlib 
+   :members:
+   :undoc-members:
+
+
+

docs/makedocs

@@ -133,6 +133,18 @@ makedocs ()
     cp -r htmltemp.$$/examples/* docs/chm/docs
     rm -rf htmltemp.$$
 
+    # Create python docs.  If we are making a release then stop immediately if 
+    # the python docs can't be created (this happens if the .so file isn't compiled)
+    if [ "$1" = "makerel" ] 
+        then
+        sphinx-build -b html docs/python sphinx.$$ || report_failure
+    else
+        sphinx-build -b html docs/python sphinx.$$
+    fi;
+
+    cp -r sphinx.$$ docs/web/python
+    mv  sphinx.$$ docs/chm/docs/python
+
     cp docs/cache/dlib/test/makefile docs/web/dlib/test
     cp docs/cache/dlib/test/makefile docs/chm/docs/dlib/test
 

docs/testenv

@@ -23,6 +23,7 @@ tar --help 		> /dev/null || return_error "tar";
 zip -h 			> /dev/null || return_error "zip";
 bzip2 -h 	       &> /dev/null || return_error "bzip2";
 pygmentize -h 	       &> /dev/null || return_error "pygmentize";
+which sphinx-build   &> /dev/null || return_error "sphinx-build";
 
 
 echo All needed utilities found