Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Josef-Friedrich committed Dec 15, 2017
1 parent d5c994f commit f641437
Showing 1 changed file with 38 additions and 6 deletions.
44 changes: 38 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@
.. image:: https://travis-ci.org/Josef-Friedrich/tmep.svg?branch=master
:target: https://travis-ci.org/Josef-Friedrich/tmep

====================================================
tmep - Template and Macros Expansion for Path names.
====================================================
====
tmep
====

Template and Macros Expansion for Path names.

Installation
============
Expand All @@ -31,9 +33,6 @@ From PyPI
Usage
=====

Basic usage
-----------

.. code:: Python
>>> import tmep
Expand All @@ -55,3 +54,36 @@ library: unknown symbols are left intact.

This is sort of like a tiny, horrible degeneration of a real templating
engine like Jinja2 or Mustache.

Development
===========

Test
----

::

tox


Publish a new version
---------------------

::

git tag 1.1.1
git push --tags
python setup.py sdist upload


Package documentation
---------------------

The package documentation is hosted on
`readthedocs <http://tmep.readthedocs.io>`_.

Generate the package documentation:

::

python setup.py build_sphinx

0 comments on commit f641437

Please sign in to comment.