changes: re-arrange sphinx-docs

tanbro · Apr 19, 2018 · 911613c · 911613c
1 parent 88e9819
commit 911613c
Show file tree

Hide file tree

Showing 14 changed files with 29 additions and 5 deletions.
diff --git a/docs/exosip2ctypes.call.rst → docs/apidoc/exosip2ctypes.call.rst b/docs/exosip2ctypes.call.rst → docs/apidoc/exosip2ctypes.call.rst
diff --git a/docs/exosip2ctypes.context.rst → docs/apidoc/exosip2ctypes.context.rst b/docs/exosip2ctypes.context.rst → docs/apidoc/exosip2ctypes.context.rst
diff --git a/docs/exosip2ctypes.error.rst → docs/apidoc/exosip2ctypes.error.rst b/docs/exosip2ctypes.error.rst → docs/apidoc/exosip2ctypes.error.rst
diff --git a/docs/exosip2ctypes.event.rst → docs/apidoc/exosip2ctypes.event.rst b/docs/exosip2ctypes.event.rst → docs/apidoc/exosip2ctypes.event.rst
diff --git a/docs/exosip2ctypes.message.rst → docs/apidoc/exosip2ctypes.message.rst b/docs/exosip2ctypes.message.rst → docs/apidoc/exosip2ctypes.message.rst
diff --git a/docs/exosip2ctypes.register.rst → docs/apidoc/exosip2ctypes.register.rst b/docs/exosip2ctypes.register.rst → docs/apidoc/exosip2ctypes.register.rst
diff --git a/docs/exosip2ctypes.rst → docs/apidoc/exosip2ctypes.rst b/docs/exosip2ctypes.rst → docs/apidoc/exosip2ctypes.rst
@@ -4,8 +4,7 @@ exosip2ctypes package
 Submodules
 ----------
 
-.. autosummary::
-   :toctree: modules
+.. toctree::
 
    exosip2ctypes.call
    exosip2ctypes.context

diff --git a/docs/exosip2ctypes.sdp.rst → docs/apidoc/exosip2ctypes.sdp.rst b/docs/exosip2ctypes.sdp.rst → docs/apidoc/exosip2ctypes.sdp.rst
diff --git a/docs/exosip2ctypes.utils.rst → docs/apidoc/exosip2ctypes.utils.rst b/docs/exosip2ctypes.utils.rst → docs/apidoc/exosip2ctypes.utils.rst
diff --git a/docs/exosip2ctypes.version.rst → docs/apidoc/exosip2ctypes.version.rst b/docs/exosip2ctypes.version.rst → docs/apidoc/exosip2ctypes.version.rst
diff --git a/docs/modules.rst → docs/apidoc/modules.rst b/docs/modules.rst → docs/apidoc/modules.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -32,7 +32,7 @@
 # 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('../src'))
+
 
 # -- General configuration ------------------------------------------------
 
@@ -48,6 +48,7 @@
     'sphinx.ext.mathjax',
     'sphinx.ext.ifconfig',
     'sphinx.ext.autosectionlabel',
+    'sphinx.ext.autosummary',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/docs/index.rst b/docs/index.rst
@@ -9,9 +9,28 @@ Welcome to exosip2ctypes's documentation!
 :Version:     |version|
 :Release:     |release|
 
-.. toctree::
+Summaries
+=========
+
+.. autosummary::
+   :toctree: modules
+
+   exosip2ctypes.call
+   exosip2ctypes.context
+   exosip2ctypes.error
+   exosip2ctypes.event
+   exosip2ctypes.message
+   exosip2ctypes.register
+   exosip2ctypes.sdp
+   exosip2ctypes.utils
+   exosip2ctypes.version
 
-    modules
+
+Contents
+========
+
+.. toctree::
+    apidoc/modules
 
 Indices and tables
 ==================

diff --git a/src/exosip2ctypes/message.py b/src/exosip2ctypes/message.py
@@ -1,5 +1,10 @@
 # -*- coding: utf-8 -*-
 
+"""osip and eXosip messages
+
+Message classes of osip and eXosip
+"""
+
 from __future__ import absolute_import, unicode_literals
 
 from ctypes import POINTER, byref, string_at, create_string_buffer, c_void_p, c_char_p, c_int, c_size_t