From 4c004e56f9527eea2280cfa840a568c5ea10cee7 Mon Sep 17 00:00:00 2001
From: Joseph Weston <joseph.weston08@gmail.com>
Date: Wed, 12 Apr 2017 14:55:17 +0200
Subject: [PATCH] doc: add wraparound module to documentation
Closes #113.
---
doc/source/reference/index.rst | 1 +
doc/source/reference/kwant.plotter.rst | 1 +
doc/source/reference/kwant.wraparound.rst | 8 ++++++++
kwant/wraparound.py | 2 +-
4 files changed, 11 insertions(+), 1 deletion(-)
create mode 100644 doc/source/reference/kwant.wraparound.rst
diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst
index fd88a0a5..479356d6 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 1492441f..3d2b7107 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 00000000..f446535b
--- /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 1936486b..2bf07c2c 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 "
--
GitLab