GPL header / description.

1 files changed, 29 insertions, 0 deletions

diff --git a/exts/tsref.py b/exts/tsref.py
index c7d6089e..b4d2db40 100644
--- a/exts/tsref.py
+++ b/exts/tsref.py
@@ -1,3 +1,32 @@
+# Copyright (C) 2016  Florian Dold
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+This extension adds a new lexer "tsref", which
+allows reST-style links inside comments (`LinkName`_),
+and semi-automatically adds links to references to types.
+
+For type TYPE, a reference to tsref-type-TYPE is added.
+
+Known bugs and limitations:
+ - The way the extension works right now interferes wiht
+   Sphinx's caching, the build directory should be cleared
+   before every build.
+"""
+
+
 from pygments.util import get_bool_opt
 from pygments.token import Name, Comment, Token, _TokenType
 from pygments.filter import Filter