Skip to content

Commit 7e0ab10

Browse files
committed
Reamed Compiler class to work around an autosummary bug
1 parent 32b3d6e commit 7e0ab10

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

labscript/compiler.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,10 @@
2525
_SAVE_GIT_INFO = LabConfig().getboolean("labscript", "save_git_info", fallback=False)
2626

2727

28-
class Compiler(object):
28+
# Note: This class name is chosen to work around a autosummary bug, see
29+
# https://github.com/sphinx-doc/sphinx/issues/11362 It could be reverted to just
30+
# ``Compiler`` once the bug is fixed.
31+
class _Compiler(object):
2932
"""Compiler singleton that saves relevant parameters during compilation of each shot"""
3033

3134
_instance = None
@@ -85,5 +88,5 @@ def reset(self):
8588
self.compression = 'gzip' # set to 'gzip' for compression
8689

8790

88-
compiler = Compiler()
91+
compiler = _Compiler()
8992
"""The compiler instance"""

0 commit comments

Comments
 (0)