Menu
▾
▴
Tree [64bb9d] master 0.7.0 / History
| File | Date | Author | Commit |
|---|---|---|---|
| docs | 2024-08-01 |
Dave Brondsema
|
[9fb3f7] update intersphinx_mapping for Sphinx 8 |
| pypeline | 2024-11-14 |
Dave Brondsema
|
[896436] update python versions; update textile output |
| .gitignore | 2022-07-29 |
Ellery Alvarez
|
[5a12b4] pytest error for skips |
| README.txt | 2022-04-18 |
Dave Brondsema
|
[91cd84] Tweak install instructions |
| pytest.ini | 2022-07-26 |
Ellery Alvarez
|
[f42b28] replaced nose with pytest |
| setup.py | 2024-11-14 |
Dave Brondsema
|
[64bb9d] version 0.7.0 |
| tox.ini | 2024-11-14 |
Dave Brondsema
|
[896436] update python versions; update textile output |
Read Me
=========================
Getting to Know Pypeline
=========================
A Brief History
----------------
There are a wide variety of plain text-based syntaxes for generating
documentation, including HTML. GitHub's Markup
[http://github.com/github/markup/] library provides a way to handle all of
these formats in an easily-extensible manner. Pypeline provides the same
functionality in a native Python library.
Installing Pypeline
--------------------
In order to install Pypeline, pip install it. (We recommend using a virtualenv
[http://pypi.python.org/pypi/virtualenv] for development.)
$ virtualenv pypeline_env
$ source pypeline_env/bin/activate
(pypeline_env)$ pip install pypeline
Getting Started
----------------
Out of the box Pypeline supports the following markups:
* Markdown
* Textile
* ReST
* Creole
* Plain text
To get started with these:
>>> from pypeline.markup import markup
>>> markup.render('foo.txt')
