summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Matusiak <numerodix@gmail.com>2014-03-09 12:38:48 +0100
committerMartin Matusiak <numerodix@gmail.com>2014-03-09 12:38:48 +0100
commit88f78d83279db6c3a471fea818744516d94a4381 (patch)
tree9caf4715ee74f147524a0f0b0eec80096f5c5296
parentb677dab2561657b4c493cd791dc5884ff9919cfd (diff)
parent42cec2c4fa4d5e9f859f52412a831f4c3fa8d5c9 (diff)
downloadansicolor-88f78d83279db6c3a471fea818744516d94a4381.tar.gz
Merge branch 'release/0.1.5'0.1.5
-rw-r--r--README.rst11
-rw-r--r--ansicolor/__init__.py2
l---------docs/README.rst1
-rw-r--r--docs/conf.py4
-rw-r--r--docs/index.rst4
-rw-r--r--docs/snippets/getting_started_1.pngbin0 -> 8809 bytes
-rw-r--r--docs/snippets/getting_started_1.py9
7 files changed, 16 insertions, 15 deletions
diff --git a/README.rst b/README.rst
index 65e741d..a3d16a7 100644
--- a/README.rst
+++ b/README.rst
@@ -33,16 +33,9 @@ Getting started
To highlight using colors:
-.. code:: python
-
- from ansicolor import green
- from ansicolor import red
- from ansicolor import white
+.. literalinclude:: snippets/getting_started_1.py
- print("Let's try two colors: %s and %s!" % (red("red"), green("green")))
- print("It's also easy to produce text in %s," % (red("bold", bold=True)))
- print("...%s," % (green("reverse", reverse=True)))
- print("...and %s." % (cyan("bold and reverse", bold=True, reverse=True)))
+.. figure:: snippets/getting_started_1.png
This will emit ansi escapes into the string: one when starting a color, another
diff --git a/ansicolor/__init__.py b/ansicolor/__init__.py
index a1a43c9..bf6cd9f 100644
--- a/ansicolor/__init__.py
+++ b/ansicolor/__init__.py
@@ -32,5 +32,5 @@ __all__ = [
]
__major_version__ = "0.1"
-__release__ = "4"
+__release__ = "5"
__version__ = "%s.%s" % (__major_version__, __release__)
diff --git a/docs/README.rst b/docs/README.rst
new file mode 120000
index 0000000..89a0106
--- /dev/null
+++ b/docs/README.rst
@@ -0,0 +1 @@
+../README.rst \ No newline at end of file
diff --git a/docs/conf.py b/docs/conf.py
index afcc661..a8b8082 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -55,7 +55,7 @@ master_doc = 'index'
# General information about the project.
project = ansicolor.__name__
-copyright = u'2010-2014, %s' % author
+copyright = u'2008-2014, %s' % author
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -275,7 +275,7 @@ texinfo_documents = [
epub_title = ansicolor.__name__
epub_author = author
epub_publisher = author
-epub_copyright = u'2010-2014, %s' % author
+epub_copyright = u'2008-2014, %s' % author
# The basename for the epub file. It defaults to the project name.
#epub_basename = u'ansicolor'
diff --git a/docs/index.rst b/docs/index.rst
index 2dc5b38..e0e71d1 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -6,11 +6,10 @@
Welcome to ansicolor's documentation!
=====================================
-Contents:
-
.. toctree::
:maxdepth: 4
+ README.rst
ansicolor
@@ -20,4 +19,3 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
-
diff --git a/docs/snippets/getting_started_1.png b/docs/snippets/getting_started_1.png
new file mode 100644
index 0000000..d34261f
--- /dev/null
+++ b/docs/snippets/getting_started_1.png
Binary files differ
diff --git a/docs/snippets/getting_started_1.py b/docs/snippets/getting_started_1.py
new file mode 100644
index 0000000..dd76ab7
--- /dev/null
+++ b/docs/snippets/getting_started_1.py
@@ -0,0 +1,9 @@
+from ansicolor import cyan
+from ansicolor import green
+from ansicolor import red
+from ansicolor import white
+
+print("Let's try two colors: %s and %s!" % (red("red"), green("green")))
+print("It's also easy to produce text in %s," % (red("bold", bold=True)))
+print("...%s," % (green("reverse", reverse=True)))
+print("...and %s." % (cyan("bold and reverse", bold=True, reverse=True)))