Skip to content

Commit acdc08f

Browse files
JoschDJoschD
committed
docs
1 parent e77db56 commit acdc08f

File tree

18 files changed

+126
-41
lines changed

18 files changed

+126
-41
lines changed

‎doc/conf.py‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -227,9 +227,7 @@
227227

228228
# Add here all modules to be mocked up. When the dependencies are not met
229229
# at building time. Here used to have PyQT mocked.
230-
autodoc_mock_imports = ['PyQt5', 'PyQt5.QtGui', 'PyQt5.QtCore', 'PyQt5.QtWidgets',
231-
"matplotlib.backends.backend_qt5agg",
232-
]
230+
autodoc_mock_imports = ["accwidgets", "qtpy"]
233231

234232
# -- Type Aliases --------------------------------------------------------------
235233

‎doc/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Welcome to omc3-GUI's documentation!
2-
================================
2+
====================================
33

44
``omc3_gui`` is a wrapper for ``omc3`` to provide a graphical user interface for beam optics measurements and corrections in particle accelerators used by the OMC team at `CERN <https://home.cern/>`_.
55

‎doc/main/sbs_gui.rst‎

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,47 @@
1-
Segment-by-Segment GUI
2-
**********************
1+
Segment-by-Segment
2+
******************
33

44
.. automodule:: omc3_gui.sbs_gui
55
:members:
66
:noindex:
77

8-
9-
.. automodule:: omc3_gui.segment_by_segment.defaults
8+
.. automodule:: omc3_gui.segment_by_segment.main_controller
109
:members:
1110
:noindex:
1211

13-
.. automodule:: omc3_gui.segment_by_segment.help_view
12+
.. automodule:: omc3_gui.segment_by_segment.main_model
1413
:members:
1514
:noindex:
1615

17-
.. automodule:: omc3_gui.segment_by_segment.main_controller
16+
.. automodule:: omc3_gui.segment_by_segment.main_view
1817
:members:
1918
:noindex:
2019

21-
.. automodule:: omc3_gui.segment_by_segment.main_model
20+
.. automodule:: omc3_gui.segment_by_segment.measurement_model
2221
:members:
2322
:noindex:
2423

25-
.. automodule:: omc3_gui.segment_by_segment.main_view
24+
.. automodule:: omc3_gui.segment_by_segment.measurement_view
2625
:members:
2726
:noindex:
2827

29-
.. automodule:: omc3_gui.segment_by_segment.measurement_model
28+
.. automodule:: omc3_gui.segment_by_segment.segment_model
3029
:members:
3130
:noindex:
3231

33-
.. automodule:: omc3_gui.segment_by_segment.measurement_view
32+
.. automodule:: omc3_gui.segment_by_segment.segment_view
3433
:members:
3534
:noindex:
3635

37-
.. automodule:: omc3_gui.segment_by_segment.plotting
36+
.. automodule:: omc3_gui.segment_by_segment.defaults
3837
:members:
3938
:noindex:
4039

41-
.. automodule:: omc3_gui.segment_by_segment.segment_model
40+
.. automodule:: omc3_gui.segment_by_segment.help_view
4241
:members:
4342
:noindex:
4443

45-
.. automodule:: omc3_gui.segment_by_segment.segment_view
44+
.. automodule:: omc3_gui.segment_by_segment.plotting
4645
:members:
4746
:noindex:
4847

‎doc/modules/ui.rst‎

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,60 @@
11
UI-Components
22
*************
33

4-
.. automodule:: omc3_gui.ui_components
4+
.. automodule:: omc3_gui.ui_components.dataclass_ui
55
:members:
66
:noindex:
7+
8+
.. automodule:: omc3_gui.ui_components.dataclass_ui.controller
9+
:members:
10+
:noindex:
11+
12+
.. automodule:: omc3_gui.ui_components.dataclass_ui.model
13+
:members:
14+
:noindex:
15+
16+
.. automodule:: omc3_gui.ui_components.dataclass_ui.view
17+
:members:
18+
:noindex:
19+
20+
.. automodule:: omc3_gui.ui_components.dataclass_ui.tools
21+
:members:
22+
:noindex:
23+
24+
.. automodule:: omc3_gui.ui_components.base_classes_cvm
25+
:members:
26+
:noindex:
27+
28+
.. automodule:: omc3_gui.ui_components.colors
29+
:members:
30+
:noindex:
31+
32+
.. automodule:: omc3_gui.ui_components.file_dialogs
33+
:members:
34+
:noindex:
35+
36+
.. automodule:: omc3_gui.ui_components.item_models
37+
:members:
38+
:noindex:
39+
40+
41+
.. automodule:: omc3_gui.ui_components.message_boxes
42+
:members:
43+
:noindex:
44+
45+
.. automodule:: omc3_gui.ui_components.styles
46+
:members:
47+
:noindex:
48+
49+
.. automodule:: omc3_gui.ui_components.text_editor
50+
:members:
51+
:noindex:
52+
53+
.. automodule:: omc3_gui.ui_components.threads
54+
:members:
55+
:noindex:
56+
57+
.. automodule:: omc3_gui.ui_components.widgets
58+
:members:
59+
:noindex:
60+

‎doc/modules/utils.rst‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
Utilities
22
*********
33

4-
.. automodule:: omc3_gui.utils
4+
.. automodule:: omc3_gui.utils.counter
5+
:members:
6+
:noindex:
7+
8+
.. automodule:: omc3_gui.utils.iteration_classes
9+
:members:
10+
:noindex:
11+
12+
.. automodule:: omc3_gui.utils.log_handler
513
:members:
614
:noindex:

‎omc3_gui/__main__.py‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
from pathlib import Path
2+
3+
this_dir = Path(__file__).parent
4+
5+
# Welcome ---
6+
print("Welcome to omc3_gui!\n")
7+
8+
# Scripts ---
9+
scripts = this_dir.glob("[a-zA-Z]*.py")
10+
print("Available entrypoints:\n")
11+
for script in scripts:
12+
print(f"omc3_gui.{script.stem}")
13+
print()

‎omc3_gui/plotting/classes.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
2-
Plotting: Classes
3-
-----------------
2+
Classes
3+
-------
44
55
Containers for figures, plots, etc.
66
"""

‎omc3_gui/segment_by_segment/defaults.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
2-
Segment-by-Segment Defaults
3-
---------------------------
2+
Defaults
3+
--------
44
55
Defaults for segment by segment.
66
"""

‎omc3_gui/segment_by_segment/main_controller.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
2-
Segment-by-Segment Controller
3-
-----------------------------
2+
Main Controller
3+
---------------
44
55
This is the main controller for the Segment-by-Segment application.
66
"""

‎omc3_gui/segment_by_segment/main_model.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
2-
Segment-by-Segment Model
3-
------------------------
2+
Main Model
3+
----------
44
55
This is the main model for the Segment-by-Segment application.
66
"""

0 commit comments

Comments
 (0)