From 0289b8907c549a419ad2ed2041532a15f41663b3 Mon Sep 17 00:00:00 2001
From: Christoph Groth <christoph.groth@cea.fr>
Date: Tue, 21 May 2013 12:20:54 +0200
Subject: [PATCH] add kwant.contrib to docs
---
doc/source/contrib/digest.rst | 5 +++++
doc/source/contrib/index.rst | 20 ++++++++++++++++++++
doc/source/contrib/rmt.rst | 5 +++++
doc/source/index.rst | 5 +++++
doc/source/whatsnew/0.3.rst | 5 +++++
kwant/contrib/digest.py | 2 +-
6 files changed, 41 insertions(+), 1 deletion(-)
create mode 100644 doc/source/contrib/digest.rst
create mode 100644 doc/source/contrib/index.rst
create mode 100644 doc/source/contrib/rmt.rst
diff --git a/doc/source/contrib/digest.rst b/doc/source/contrib/digest.rst
new file mode 100644
index 00000000..ee3460b9
--- /dev/null
+++ b/doc/source/contrib/digest.rst
@@ -0,0 +1,5 @@
+:mod:`kwant.contrib.digest` -- Random-access random numbers
+===========================================================
+
+.. automodule:: kwant.contrib.digest
+ :members:
diff --git a/doc/source/contrib/index.rst b/doc/source/contrib/index.rst
new file mode 100644
index 00000000..31b09f00
--- /dev/null
+++ b/doc/source/contrib/index.rst
@@ -0,0 +1,20 @@
+:mod:`kwant.contrib` -- Contributed modules
+===========================================
+
+.. module:: kwant.contrib
+
+Although this collection of modules is available as part of the official kwant
+distribution, it is not considered to be an integral part of kwant. The
+intention is to keep interesting modules that are useful with kwant here (maybe
+even experimental ones) to give users an easier access to them, and to give them
+wider exposure, so that they can be improved faster. Users of kwant are welcome
+to submit their own modules for inclusion in :mod:`kwant.contrib`.
+
+For simplicity, all contributions share the same license as kwant. (This
+requirement may be relaxed to allow other free licenses if requested.)
+
+.. toctree::
+ :maxdepth: 1
+
+ digest
+ rmt
diff --git a/doc/source/contrib/rmt.rst b/doc/source/contrib/rmt.rst
new file mode 100644
index 00000000..929b7916
--- /dev/null
+++ b/doc/source/contrib/rmt.rst
@@ -0,0 +1,5 @@
+:mod:`kwant.contrib.rmt` -- RMT (random matrix theory) Hamiltonians
+===================================================================
+
+.. automodule:: kwant.contrib.rmt
+ :members:
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 5708837c..83bf2722 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -34,4 +34,9 @@ have made it possible <authors>`.
reference/index
+.. toctree::
+ :maxdepth: 2
+
+ contrib/index
+
* :ref:`genindex`
diff --git a/doc/source/whatsnew/0.3.rst b/doc/source/whatsnew/0.3.rst
index 84b0da4b..2f852cab 100644
--- a/doc/source/whatsnew/0.3.rst
+++ b/doc/source/whatsnew/0.3.rst
@@ -156,3 +156,8 @@ Modes or self-energies can now be precomputed before passing the system to a
solver, using the method `~kwant.system.FiniteSystem.precalculate`. This may
save time, when the linear system has to be solved many times with the same
lead parameters.
+
+Inclusion of contributed modules
+--------------------------------
+kwant now contains a sub-package :mod:`kwant.contrib` that contains various
+modules that are useful with kwant but are not considered to be part of it.
diff --git a/kwant/contrib/digest.py b/kwant/contrib/digest.py
index 54fd975b..cc9f01fc 100644
--- a/kwant/contrib/digest.py
+++ b/kwant/contrib/digest.py
@@ -6,7 +6,7 @@
# the AUTHORS file at the top-level directory of this distribution and at
# http://kwant-project.org/authors.
-"""A module for "functional" random numbers.
+"""Random-access random numbers
This module provides routines that given some input compute a "random" output
that depends on the input in a (cryptographically) intractable way.
--
GitLab