reorder methods in generated docs

Signed-off-by: Andrey Parfenov <andrei@dps.uibk.ac.at>
brainflow-dev · Sep 26, 2019 · b25cc13 · b25cc13
1 parent c56cd89
commit b25cc13
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/docs/UserAPI.rst b/docs/UserAPI.rst
@@ -18,6 +18,7 @@ brainflow.board\_shim
    :members:
    :noindex:
    :show-inheritance:
+   :member-order: bysource
 
 brainflow.exit\_codes
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -27,6 +28,7 @@ brainflow.exit\_codes
    :undoc-members:
    :noindex:
    :show-inheritance:
+   :member-order: bysource
 
 brainflow.preprocess
 ~~~~~~~~~~~~~~~~~~~~~
@@ -36,3 +38,4 @@ brainflow.preprocess
    :undoc-members:
    :noindex:
    :show-inheritance:
+   :member-order: bysource
diff --git a/docs/conf.py b/docs/conf.py
@@ -43,8 +43,12 @@
     'sphinx.ext.autodoc'
 ]
 
+# sphinx.ext.autodoc
+autoclass_content = 'both'
+autodoc_default_options = {"members": None}
 autodoc_member_order = 'bysource'
 
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

diff --git a/python-package/brainflow/board_shim.py b/python-package/brainflow/board_shim.py
@@ -231,20 +231,21 @@ def __init__ (self, board_id, port_name):
 
     @classmethod
     def enable_board_logger (cls):
-        """enable board logger to stderr"""
+        """enable board logger"""
         res = BoardControllerDLL.get_instance ().set_log_level (2)
         if res != StreamExitCodes.STATUS_OK.value:
             raise BrainFlowError ('unable to enable logger', res)
 
     @classmethod
     def disable_board_logger (cls):
-        """disable board logger to stderr"""
+        """disable board logger"""
         res = BoardControllerDLL.get_instance ().set_log_level (6)
         if res != StreamExitCodes.STATUS_OK.value:
             raise BrainFlowError ('unable to disable logger', res)
 
     @classmethod
     def enable_dev_board_logger (cls):
+        """enable it to check developers log messages"""
         res = BoardControllerDLL.get_instance ().set_log_level (0)
         if res != StreamExitCodes.STATUS_OK.value:
             raise BrainFlowError ('unable to enable logger', res)