adds docs

wrapper/python/docs/conf.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
-# wolfCrypt documentation build configuration file, created by
-# sphinx-quickstart on Fri Apr 29 16:04:23 2016.
+# wolfcrypt documentation build configuration file, created by
+# sphinx-quickstart on Fri Apr 29 16:47:53 2016.
 #
 # This file is execfile()d with the current directory set to its
 # containing dir.
@@ -31,8 +31,10 @@ import sphinx_rtd_theme
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
     'sphinx.ext.coverage',
     'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -50,18 +52,21 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-project = u'wolfCrypt'
-copyright = u'2016, wolfSSL'
+project = u'wolfcrypt'
+copyright = u'2016, wolfSSL Inc. All rights reserved'
 author = u'wolfSSL'
 
 # 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 = u'0.0'
-# The full version, including alpha/beta/rc tags.
-release = u'0.0.1'
+
+base_dir = os.path.join(os.path.dirname(__file__), os.pardir)
+about = {}
+with open(os.path.join(base_dir, "wolfcrypt", "about.py")) as f:
+    exec(f.read(), about)
+
+version = release = about["__version__"]
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -125,7 +130,7 @@ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # The name for this set of Sphinx documents.
 # "<project> v<release> documentation" by default.
-#html_title = u'wolfCrypt v0.0.1'
+#html_title = u'%s v%s' % (project, release)
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #html_short_title = None
@@ -207,7 +212,7 @@ html_static_path = ['_static']
 #html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'wolfCryptdoc'
+htmlhelp_basename = 'wolfcrypt-pydoc'
 
 # -- Options for LaTeX output ---------------------------------------------
 
@@ -229,7 +234,7 @@ latex_elements = {
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'wolfCrypt.tex', u'wolfCrypt Documentation',
+    (master_doc, 'wolfcrypt.tex', u'wolfcrypt Python Documentation',
      u'wolfSSL', 'manual'),
 ]
 
@@ -259,7 +264,7 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'wolfcrypt', u'wolfCrypt Documentation',
+    (master_doc, 'wolfcrypt', u'wolfcrypt Python Documentation',
      [author], 1)
 ]
 
@@ -273,8 +278,8 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'wolfCrypt', u'wolfCrypt Documentation',
-     author, 'wolfCrypt', 'One line description of project.',
+    (master_doc, 'wolfcrypt', u'wolfcrypt Python Documentation',
+     author, 'wolfcrypt', 'One line description of project.',
      'Miscellaneous'),
 ]
 
@@ -289,3 +294,6 @@ texinfo_documents = [
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 #texinfo_no_detailmenu = False
+
+# Preserves the order of the members, doesn't sorts them alphabetically.
+autodoc_member_order = 'bysource'