Skip to content

Commit c753ba2

Browse files
committed
DOCS: add :no-index: to autodoc directives in Hamiltonian.md
1 parent 46c4c5b commit c753ba2

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

core/docs/Hamiltonian.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ external_field.direction = [0.0, 0.0, 1.0]
3030
:::{tab-item} Python
3131
```{eval-rst}
3232
.. autofunction:: spirit.hamiltonian.set_field
33+
:no-index:
3334
.. autofunction:: spirit.hamiltonian.get_field
35+
:no-index:
3436
```
3537
:::
3638

@@ -88,7 +90,9 @@ i Kx Ky Kz K K4
8890
:::{tab-item} Python
8991
```{eval-rst}
9092
.. autofunction:: spirit.hamiltonian.get_anisotropy
93+
:no-index:
9194
.. autofunction:: spirit.hamiltonian.set_anisotropy
95+
:no-index:
9296
```
9397
:::
9498

@@ -153,7 +157,9 @@ i n1 n2 n3 K
153157
:::{tab-item} Python
154158
```{eval-rst}
155159
.. autofunction:: spirit.hamiltonian.get_biaxial_anisotropy
160+
:no-index:
156161
.. autofunction:: spirit.hamiltonian.set_biaxial_anisotropy
162+
:no-index:
157163
```
158164
:::
159165

@@ -224,11 +230,17 @@ If the `Jij` or `Dij` keywords used for shells are present the associated column
224230
:::{tab-item} Python
225231
```{eval-rst}
226232
.. autodata:: spirit.hamiltonian.CHIRALITY_BLOCH
233+
:no-index:
227234
.. autodata:: spirit.hamiltonian.CHIRALITY_NEEL
235+
:no-index:
228236
.. autodata:: spirit.hamiltonian.CHIRALITY_BLOCH_INVERSE
237+
:no-index:
229238
.. autodata:: spirit.hamiltonian.CHIRALITY_NEEL_INVERSE
239+
:no-index:
230240
.. autofunction:: spirit.hamiltonian.set_dmi
241+
:no-index:
231242
.. autofunction:: spirit.hamiltonian.set_exchange
243+
:no-index:
232244
```
233245
:::
234246

@@ -341,10 +353,15 @@ ddi_pb_zero_padding = 1.0
341353
:::{tab-item} Python
342354
```{eval-rst}
343355
.. autodata:: spirit.hamiltonian.DDI_METHOD_NONE
356+
:no-index:
344357
.. autodata:: spirit.hamiltonian.DDI_METHOD_FFT
358+
:no-index:
345359
.. autodata:: spirit.hamiltonian.DDI_METHOD_CUTOFF
360+
:no-index:
346361
.. autofunction:: spirit.hamiltonian.get_ddi
362+
:no-index:
347363
.. autofunction:: spirit.hamiltonian.set_ddi
364+
:no-index:
348365
```
349366
:::
350367

0 commit comments

Comments
 (0)