diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index fd88a0a5db9b0f2322dbfc03cc26a38be19c5d41..479356d6c0b7002645e3b0ec63374c5ab617662e 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -38,3 +38,4 @@ The following modules provide functionality for special applications. kwant.digest kwant.rmt kwant.kpm + kwant.wraparound diff --git a/doc/source/reference/kwant.plotter.rst b/doc/source/reference/kwant.plotter.rst index 1492441f5dcdcc458132b94bdf999b6726111275..3d2b71079581859d0f98773c0e42965cc65dbf50 100644 --- a/doc/source/reference/kwant.plotter.rst +++ b/doc/source/reference/kwant.plotter.rst @@ -12,6 +12,7 @@ Plotting routine plot map bands + spectrum Data-generating functions ------------------------- diff --git a/doc/source/reference/kwant.wraparound.rst b/doc/source/reference/kwant.wraparound.rst new file mode 100644 index 0000000000000000000000000000000000000000..f446535ba63c15877dca2e244cc1f0efa846eb51 --- /dev/null +++ b/doc/source/reference/kwant.wraparound.rst @@ -0,0 +1,8 @@ +:mod:`kwant.wraparound` -- Wrapping around translational symmetries +=================================================================== +.. module:: kwant.wraparound +.. autosummary:: + :toctree: generated/ + + wraparound + plot_2d_bands diff --git a/kwant/wraparound.py b/kwant/wraparound.py index 1936486bd85e96f42d0e96cb8e39e335c7eb08ca..2bf07c2cc3cfb0f161879a4c0dc8a4574f747191 100644 --- a/kwant/wraparound.py +++ b/kwant/wraparound.py @@ -384,7 +384,7 @@ def plot_2d_bands(syst, k_x=31, k_y=31, params=None, See Also -------- - `kwant.plotter.spectrum` + kwant.plotter.spectrum """ if not hasattr(syst, '_wrapped_symmetry'): raise TypeError("Expecting a system that was produced by "