summaryrefslogtreecommitdiffstats
path: root/scripts
diff options
context:
space:
mode:
authorHanoh Haim <hhaim@cisco.com>2016-06-16 15:45:20 +0300
committerHanoh Haim <hhaim@cisco.com>2016-06-16 15:45:20 +0300
commit6824df7cf39cfaee127033f48cebf6de3f3e5b56 (patch)
tree1fa174aab9541bfb159afb25192264674700579b /scripts
parent14774ed2eabf8a6f218e8674a04ee7d8ce373d64 (diff)
fix python doc strings
Diffstat (limited to 'scripts')
-rw-r--r--scripts/automation/trex_control_plane/doc_stl/conf.py18
1 files changed, 17 insertions, 1 deletions
diff --git a/scripts/automation/trex_control_plane/doc_stl/conf.py b/scripts/automation/trex_control_plane/doc_stl/conf.py
index 45738b6e..c8788ca7 100644
--- a/scripts/automation/trex_control_plane/doc_stl/conf.py
+++ b/scripts/automation/trex_control_plane/doc_stl/conf.py
@@ -15,6 +15,21 @@
import sys
import os
import shlex
+import functools
+
+def no_op_wraps(func):
+ """Replaces functools.wraps in order to undo wrapping.
+
+ Can be used to preserve the decorated function's signature
+ in the documentation generated by Sphinx.
+
+ """
+ def wrapper(decorator):
+ return func
+ return wrapper
+
+functools.wraps = no_op_wraps
+
# If extensions (or modules to document with autodoc) are in another directory,
@@ -309,4 +324,5 @@ autoclass_content = "both"
# A workaround for the responsive tables always having annoying scrollbars.
def setup(app):
- app.add_stylesheet("no_scrollbars.css") \ No newline at end of file
+ app.add_stylesheet("no_scrollbars.css")
+