Skip to content

Commit 83eac7e

Browse files
committed
FIX EXPANDED PUBLIC ELEMENTS IN SIDEBAR
1 parent 9bf4c46 commit 83eac7e

File tree

7 files changed

+47
-1
lines changed

7 files changed

+47
-1
lines changed

docs/api/cpymadtools.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,60 +7,79 @@ The ``cpymadtools`` subpackage is a collection of utilities to conveniently hand
77

88
.. automodule:: pyhdtoolkit.cpymadtools.constants
99
:members:
10+
:noindex:
1011

1112
.. automodule:: pyhdtoolkit.cpymadtools.coupling
1213
:members:
14+
:noindex:
1315

1416
.. automodule:: pyhdtoolkit.cpymadtools.lhc
1517
:members:
18+
:noindex:
1619

1720
.. automodule:: pyhdtoolkit.cpymadtools.lhc._coupling
1821
:members:
22+
:noindex:
1923

2024
.. automodule:: pyhdtoolkit.cpymadtools.lhc._elements
2125
:members:
26+
:noindex:
2227

2328
.. automodule:: pyhdtoolkit.cpymadtools.lhc._errors
2429
:members:
30+
:noindex:
2531

2632
.. automodule:: pyhdtoolkit.cpymadtools.lhc._misc
2733
:members:
34+
:noindex:
2835

2936
.. automodule:: pyhdtoolkit.cpymadtools.lhc._powering
3037
:members:
38+
:noindex:
3139

3240
.. automodule:: pyhdtoolkit.cpymadtools.lhc._queries
3341
:members:
42+
:noindex:
3443

3544
.. automodule:: pyhdtoolkit.cpymadtools.lhc._routines
3645
:members:
46+
:noindex:
3747

3848
.. automodule:: pyhdtoolkit.cpymadtools.lhc._setup
3949
:members:
50+
:noindex:
4051

4152
.. automodule:: pyhdtoolkit.cpymadtools.lhc._twiss
4253
:members:
54+
:noindex:
4355

4456
.. automodule:: pyhdtoolkit.cpymadtools.matching
4557
:members:
58+
:noindex:
4659

4760
.. automodule:: pyhdtoolkit.cpymadtools.parameters
4861
:members:
62+
:noindex:
4963

5064
.. automodule:: pyhdtoolkit.cpymadtools.ptc
5165
:members:
66+
:noindex:
5267

5368
.. automodule:: pyhdtoolkit.cpymadtools.track
5469
:members:
70+
:noindex:
5571

5672
.. automodule:: pyhdtoolkit.cpymadtools.tune
5773
:members:
74+
:noindex:
5875

5976
.. automodule:: pyhdtoolkit.cpymadtools.twiss
6077
:members:
78+
:noindex:
6179

6280
.. automodule:: pyhdtoolkit.cpymadtools.utils
6381
:members:
82+
:noindex:
6483

6584

6685
.. _MAD-X: https://mad.web.cern.ch/mad/

docs/api/maths.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ Maths
55

66
.. automodule:: pyhdtoolkit.maths.stats_fitting
77
:members:
8+
:noindex:
89

910
.. automodule:: pyhdtoolkit.maths.utils
1011
:members:
12+
:noindex:

docs/api/models.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,12 @@ Models
55

66
.. automodule:: pyhdtoolkit.models.beam
77
:members:
8+
:noindex:
89

910
.. automodule:: pyhdtoolkit.models.htc
1011
:members:
12+
:noindex:
1113

1214
.. automodule:: pyhdtoolkit.models.madx
1315
:members:
16+
:noindex:

docs/api/optics.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,16 @@ Optics
55

66
.. automodule:: pyhdtoolkit.optics.beam
77
:members:
8+
:noindex:
89

910
.. automodule:: pyhdtoolkit.optics.rdt
1011
:members:
12+
:noindex:
1113

1214
.. automodule:: pyhdtoolkit.optics.ripken
1315
:members:
16+
:noindex:
1417

1518
.. automodule:: pyhdtoolkit.optics.twiss
1619
:members:
20+
:noindex:

docs/api/plotting.rst

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,40 +6,52 @@ Plotting
66

77
.. automodule:: pyhdtoolkit.plotting.styles
88
:members:
9-
9+
:noindex:
1010

1111
.. automodule:: pyhdtoolkit.plotting.styles.paper
1212
:members:
13+
:noindex:
1314

1415
.. automodule:: pyhdtoolkit.plotting.styles.thesis
1516
:members:
17+
:noindex:
1618

1719
.. automodule:: pyhdtoolkit.plotting.aperture
1820
:members:
21+
:noindex:
1922

2023
.. automodule:: pyhdtoolkit.plotting.crossing
2124
:members:
25+
:noindex:
2226

2327
.. automodule:: pyhdtoolkit.plotting.envelope
2428
:members:
29+
:noindex:
2530

2631
.. automodule:: pyhdtoolkit.plotting.lattice
2732
:members:
33+
:noindex:
2834

2935
.. automodule:: pyhdtoolkit.plotting.layout
3036
:members:
37+
:noindex:
3138

3239
.. automodule:: pyhdtoolkit.plotting.phasespace
3340
:members:
41+
:noindex:
3442

3543
.. automodule:: pyhdtoolkit.plotting.tune
3644
:members:
45+
:noindex:
3746

3847
.. automodule:: pyhdtoolkit.plotting.sbs.coupling
3948
:members:
49+
:noindex:
4050

4151
.. automodule:: pyhdtoolkit.plotting.sbs.phase
4252
:members:
53+
:noindex:
4354

4455
.. automodule:: pyhdtoolkit.plotting.utils
4556
:members:
57+
:noindex:

docs/api/utils.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,20 @@ Utils
55

66
.. automodule:: pyhdtoolkit.utils.cmdline
77
:members:
8+
:noindex:
89

910
.. automodule:: pyhdtoolkit.utils.contexts
1011
:members:
12+
:noindex:
1113

1214
.. automodule:: pyhdtoolkit.utils.htc_monitor
1315
:members:
16+
:noindex:
1417

1518
.. automodule:: pyhdtoolkit.utils.logging
1619
:members:
20+
:noindex:
1721

1822
.. .. automodule:: pyhdtoolkit.utils._misc
1923
.. :members:
24+
.. :noindex:

docs/releases/v1.7.0.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ Documentation
3232
~~~~~~~~~~~~~
3333

3434
* Fixed various inconsistencies.
35+
* Fixed all public members being displayed in the sidebar, which should now be readable again.
3536
* The docstrings of functions in the `pyhdtoolkit.optics.rdt` module now display the version they were added in, and contain examples.
3637
* The whole package's docstrings have been migrated to use `numpy` style to better fit their depth. While the build documentation has not changed, users exploring function docstrings will have a better time reading them.
3738

0 commit comments

Comments
 (0)