summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas Waldmann <tw AT waldmann-edv DOT de>2014-06-28 17:18:15 +0200
committerThomas Waldmann <tw AT waldmann-edv DOT de>2014-06-28 17:18:15 +0200
commit2b06da3ea565cae889f4bd638e606060e35869b7 (patch)
tree4d00c8d6a18401229aee35d26a7570be5d23134f
parent9210ac071846c29952db109b93566ee062decba8 (diff)
downloadxstatic-2b06da3ea565cae889f4bd638e606060e35869b7.tar.gz
include license/authors into sphinx docs, minor docs fix
-rw-r--r--AUTHORS.txt2
-rw-r--r--LICENSE.txt2
-rw-r--r--docs/source/index.rst1
-rw-r--r--docs/source/license.rst10
-rw-r--r--docs/source/using.rst1
5 files changed, 15 insertions, 1 deletions
diff --git a/AUTHORS.txt b/AUTHORS.txt
index 6460b40..5ae6a16 100644
--- a/AUTHORS.txt
+++ b/AUTHORS.txt
@@ -1,10 +1,12 @@
Main Authors
------------
Thomas Waldmann, tw AT waldmann-edv DOT de
+
(please add yourself above this line if you did major contributions to
the project)
Contributors
------------
+
(please add yourself above this line if you contributed to the project)
diff --git a/LICENSE.txt b/LICENSE.txt
index cb9711d..577e9a2 100644
--- a/LICENSE.txt
+++ b/LICENSE.txt
@@ -1,7 +1,7 @@
The MIT License (MIT)
Copyright (c) 2011-2014 Thomas Waldmann <tw AT waldmann-edv DOT de> and
- other contributors, see AUTHORS.txt.
+other contributors, see AUTHORS.txt.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 63f0602..53d24a3 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -7,6 +7,7 @@ What is XStatic
:maxdepth: 2
intro
+ license
Using XStatic
diff --git a/docs/source/license.rst b/docs/source/license.rst
new file mode 100644
index 0000000..27a23cf
--- /dev/null
+++ b/docs/source/license.rst
@@ -0,0 +1,10 @@
+License
+=======
+
+.. include:: ../../LICENSE.txt
+
+Authors
+=======
+
+.. include:: ../../AUTHORS.txt
+
diff --git a/docs/source/using.rst b/docs/source/using.rst
index e7e400c..dfab752 100644
--- a/docs/source/using.rst
+++ b/docs/source/using.rst
@@ -49,6 +49,7 @@ For some packages there is also a CDN available, you can use it by giving the
appropriate provider (not 'local') and protocol (see the xstatic-* package metadata about which cdnnames and protocols are available for the package):
::
+
xs = XStatic(mod, provider='cdnname', protocol='https')
print xs.base_url