Fixed up configuration to create api documentation for the code. Improved some markup to be valid for sphinx.

Byron · Byron · commit 65dacbbd74a4 · 2011-06-13T20:23:55.000+02:00
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -16,7 +16,7 @@
 # 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.append(os.path.abspath('.'))
+sys.path.append(os.path.abspath('../../'))
 
 # -- General configuration -----------------------------------------------------
 
diff --git a/smmap/mman.py b/smmap/mman.py
@@ -354,8 +354,9 @@ def _obtain_region(self, a, offset, size, flags, is_recursive):
 	
 	#{ Interface 
 	def make_cursor(self, path_or_fd):
-		""":return: a cursor pointing to the given path or file descriptor. 
-		It can be used to map new regions of the file into memory
+		"""
+		:return: a cursor pointing to the given path or file descriptor. 
+			It can be used to map new regions of the file into memory
 		:note: if a file descriptor is given, it is assumed to be open and valid,
 			but may be closed afterwards. To refer to the same file, you may reuse
 			your existing file descriptor, but keep in mind that new windows can only
diff --git a/smmap/util.py b/smmap/util.py
@@ -20,7 +20,9 @@
 #{ Utilities
 
 def align_to_mmap(num, round_up):
-	"""Align the given integer number to the closest page offset, which usually is 4096 bytes.
+	"""
+	Align the given integer number to the closest page offset, which usually is 4096 bytes.
+	
 	:param round_up: if True, the next higher multiple of page size is used, otherwise
 		the lower page_size will be used (i.e. if True, 1 becomes 4096, otherwise it becomes 0)
 	:return: num rounded to closest page"""
