Finish 1.2.3

# Conflicts:
#	requirements/dev.txt

.travis.yml

@@ -25,8 +25,7 @@ install:
   - cd ../
   - sudo ldconfig
   - if [[ $TRAVIS_PYTHON_VERSION < '3.3' ]]; then pip install --upgrade mock; fi
-  - pip install -r requirements/dev.txt
-  - pip install codacy-coverage
+  - pip install wheel coverage codacy-coverage
   - python setup.py install
 
 before_script:

README.rst

@@ -23,8 +23,8 @@ OS:
 
 `Python`_ Version:
 
-* Python2.x: 2.7
-* Python3.x: 3.3 and later
+* `Python`_ `2.x` : `2.7`
+* `Python`_ `3.x` : `3.4` and later
 
 Installation
 ------------
@@ -39,9 +39,9 @@ Installation
 
     "develop" packages are not needed.
 
-2. Install `python`_
+2. Install `Python`_
 
-    Install `python`_ 2.7 or `python`_ 3.3+.
+    Install `Python`_ 2.7 or `Python`_ 3.4+.
     Avoid this if it's already in your OS.
 
 3. Install eXosip2CTypes
@@ -75,7 +75,7 @@ Check blow documentations for more infomations:
 
 .. _eXosip2: http://www.gnu.org/software/osip/
 
-.. _python: http://python.org/
+.. _Python: http://python.org/
 
 .. _pip: http://pypi.python.org/pypi/pip
 

docs/conf.py

@@ -15,14 +15,17 @@
 
 import sys
 import os
+from datetime import datetime
+
+from pkg_resources import get_distribution
 
 
 # -- ReadTheDocs configuration ------------------------------------------------
 
 # When RTD builds your project,
 # it sets the READTHEDOCS environment variable to the string True.
 # So within your Sphinx conf.py file, you can vary the behavior based on this
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+READTHEDOCS = os.environ.get('READTHEDOCS', None) == 'True'
 
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -44,6 +47,8 @@
     'sphinx.ext.todo',
     'sphinx.ext.mathjax',
     'sphinx.ext.ifconfig',
+    'sphinx.ext.autosectionlabel',
+    'sphinx.ext.autosummary',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -62,17 +67,17 @@
 
 # General information about the project.
 project = 'exosip2ctypes'
-copyright = '2016, Liu Xue Yan'
 author = 'Liu Xue Yan'
+copyright = '2016~{0}, {1}'.format(datetime.now().year, author)
 
 # 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 = '1.1'
 # The full version, including alpha/beta/rc tags.
-release = '1.1.3'
+release = get_distribution(project).version
+# The short X.Y version.
+version = '.'.join(release.split('.')[:2])
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -86,6 +91,7 @@
 #today = ''
 # Else, today_fmt is used as the format for a strftime call.
 #today_fmt = '%B %d, %Y'
+today_fmt = '%c'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -118,22 +124,39 @@
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
 
+# Allow reference sections using its title
+# True to prefix each section label with the name of the document it is in, followed by a colon.
+# For example, index:Introduction for a section called Introduction that appears in document index.rst.
+# Useful for avoiding ambiguity when the same section heading appears in different documents.
+autosectionlabel_prefix_document = True
+
+# Boolean indicating whether to scan all found documents for autosummary directives, and to generate stub pages for each.
+# Can also be a list of documents for which stub pages should be generated.
+# The new files will be placed in the directories specified in the :toctree: options of the directives.
+autosummary_generate = True
 
 # -- 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 = 'alabaster'
+# html_theme = 'alabaster'
 
 # 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 = {
-    'analytics_id': 'UA-76151763-1',
-    'github_banner': True,
-    'github_user': 'tanbro',
-    'github_repo': 'exosip2ctypes',
-}
+
+try:
+    html_theme
+except NameError:
+    _html_theme = ''
+else:
+    _html_theme = html_theme
+if _html_theme in ('', 'alabaster'):
+    html_theme_options = {
+        'github_banner': True,
+        'github_user': 'tanbro',
+        'github_repo': 'exosip2ctypes'
+    }
 
 # Add any paths that contain custom themes here, relative to this directory.
 #html_theme_path = []
@@ -225,17 +248,17 @@
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
+    # The paper size ('letterpaper' or 'a4paper').
+    # 'papersize': 'letterpaper',
 
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
+    # The font size ('10pt', '11pt' or '12pt').
+    # 'pointsize': '10pt',
 
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
+    # Additional stuff for the LaTeX preamble.
+    # 'preamble': '',
 
-# Latex figure (float) alignment
-#'figure_align': 'htbp',
+    # Latex figure (float) alignment
+    # 'figure_align': 'htbp',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
@@ -318,17 +341,18 @@
 
 # -- Markdown configuration ------------------------------------------------
 
-# You can use Markdown and reStructuredText in the same Sphinx project.
-# We support this natively on Read the Docs, and you can do it locally:
-from recommonmark.parser import CommonMarkParser
+# # You can use Markdown and reStructuredText in the same Sphinx project.
+# # We support this natively on Read the Docs, and you can do it locally:
+# from recommonmark.parser import CommonMarkParser
 
-source_parsers = {
-    '.md': CommonMarkParser,
-}
+# source_parsers = {
+#     '.md': CommonMarkParser,
+# }
 
-source_suffix = ['.rst', '.md']
+# source_suffix = ['.rst', '.md']
 
 
 # -- Options for sphinx.ext.intersphinx  -------------------------------------------
 extensions.append('sphinx.ext.intersphinx')
-intersphinx_mapping = {'python': ('http://docs.python.org/{0[0]}.{0[1]}'.format(sys.version_info), None)}
+intersphinx_mapping = {'python': (
+    'http://docs.python.org/{0[0]}.{0[1]}'.format(sys.version_info), None)}

docs/exosip2ctypes.rst

@@ -4,7 +4,8 @@ exosip2ctypes package
 Submodules
 ----------
 
-.. toctree::
+.. autosummary::
+   :toctree: modules
 
    exosip2ctypes.call
    exosip2ctypes.context

docs/index.rst

@@ -5,10 +5,13 @@
 
 Welcome to exosip2ctypes's documentation!
 #########################################
+:Build Time:  |today|
 :Version:     |version|
-:Date:        |today|
+:Release:     |release|
 
-.. include:: modules.rst
+.. toctree::
+
+    modules
 
 Indices and tables
 ==================

docs/modules.rst

@@ -1,5 +1,5 @@
-API Docs
-========
+exosip2ctypes
+=============
 
 .. toctree::
    :maxdepth: 4

docs/modules/exosip2ctypes.call.rst

@@ -0,0 +1,24 @@
+exosip2ctypes.call
+==================
+
+.. automodule:: exosip2ctypes.call
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Ack
+      Answer
+      InitInvite
+
+
+
+
+
+

docs/modules/exosip2ctypes.context.rst

@@ -0,0 +1,24 @@
+exosip2ctypes.context
+=====================
+
+.. automodule:: exosip2ctypes.context
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      BaseContext
+      Context
+      ContextLock
+
+
+
+
+
+

docs/modules/exosip2ctypes.error.rst

@@ -0,0 +1,47 @@
+exosip2ctypes.error
+===================
+
+.. automodule:: exosip2ctypes.error
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      raise_if_osip_error
+
+
+
+
+
+
+
+
+
+   .. rubric:: Exceptions
+
+   .. autosummary::
+
+      MallocError
+      OsipApiNotInitialized
+      OsipBadParameter
+      OsipDiskFull
+      OsipError
+      OsipFileNotExists
+      OsipNoCommonCodec
+      OsipNoMem
+      OsipNoNetwork
+      OsipNoRights
+      OsipNotFound
+      OsipPortBusy
+      OsipSyntaxError
+      OsipTimeout
+      OsipTooMuchCall
+      OsipUndefinedError
+      OsipUnknownError
+      OsipUnknownHost
+      OsipWrongFormat
+      OsipWrongState
+
+

docs/modules/exosip2ctypes.event.rst

@@ -0,0 +1,23 @@
+exosip2ctypes.event
+===================
+
+.. automodule:: exosip2ctypes.event
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Event
+      EventType
+
+
+
+
+
+

docs/modules/exosip2ctypes.message.rst

@@ -0,0 +1,23 @@
+exosip2ctypes.message
+=====================
+
+.. automodule:: exosip2ctypes.message
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      ExosipMessage
+      OsipMessage
+
+
+
+
+
+