Skip to content

Commit 714d982

Browse files
committed
Remove compiler module from autosummary documentation due to a bug that breaks documentation.
1 parent 7e0ab10 commit 714d982

File tree

2 files changed

+2
-6
lines changed

2 files changed

+2
-6
lines changed

docs/source/api/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,4 @@ API Reference
1515
labscript.labscript
1616
labscript.functions
1717
labscript.base
18-
labscript.compiler
1918
labscript.utils

labscript/compiler.py

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

2727

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):
28+
class Compiler(object):
3229
"""Compiler singleton that saves relevant parameters during compilation of each shot"""
3330

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

9087

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

0 commit comments

Comments
 (0)