Merge pull request #1965 from eirannejad/develop

Clean code samples for new documentation process

pyrevitlib/pyrevit/__init__.py

@@ -1,14 +1,16 @@
 """pyRevit root level config for all pyrevit sub-modules.
 
 Examples:
-    >>> from pyrevit import DB, UI
-    >>> from pyrevit import PyRevitException, PyRevitIOError
-
-    >>> # pyrevit module has global instance of the
-    >>> # _HostAppPostableCommand and _ExecutorParams classes already created
-    >>> # import and use them like below
-    >>> from pyrevit import HOST_APP
-    >>> from pyrevit import EXEC_PARAMS
+        '''python
+        from pyrevit import DB, UI
+        from pyrevit import PyRevitException, PyRevitIOError
+
+        # pyrevit module has global instance of the
+        # _HostAppPostableCommand and _ExecutorParams classes already created
+        # import and use them like below
+        from pyrevit import HOST_APP
+        from pyrevit import EXEC_PARAMS
+        '''
 """
 #pylint: disable=W0703,C0302,C0103,C0413,raise-missing-from
 import sys
@@ -180,8 +182,10 @@ class _HostApplication(object):
     postable commands, and other functionality.
 
     Examples:
-        >>> hostapp = _HostApplication()
-        >>> hostapp.is_newer_than(2017)
+            '''python
+            hostapp = _HostApplication()
+            hostapp.is_newer_than(2017)
+            '''
     """
 
     def __init__(self):

pyrevitlib/pyrevit/api.py

@@ -1,7 +1,9 @@
 """Provide access to Revit API.
 
 Examples:
-    >>> from pyrevit.api import AdWindows
+    '''python
+    from pyrevit.api import AdWindows
+    '''
 """
 import os.path as op
 

pyrevitlib/pyrevit/compat.py

@@ -1,8 +1,10 @@
 """python engine compatibility module.
 
 Examples:
-    >>> from pyrevit.compat import IRONPY277
-    >>> from pyrevit.compat import safe_strtype
+    '''python
+    from pyrevit.compat import IRONPY277
+    from pyrevit.compat import safe_strtype
+    '''
 """
 
 import sys