docs tweaks

databio · Jun 13, 2018 · 574dc68 · 574dc68
1 parent 0322ff4
commit 574dc68
Show file tree

Hide file tree

Showing 6 changed files with 170 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -4,24 +4,4 @@
 
 [![Documentation Status](https://readthedocs.org/projects/pypiper/badge/?version=latest)](http://pypiper.readthedocs.org/en/latest/?badge=latest)
 
-A lightweight python toolkit for gluing together restartable, robust command line pipelines. Pypiper works with [Looper](http://github.com/epigen/looper) to form a complete bioinformatics pipeline framework.
-
-The best place to learn more is at the [documentation hosted at Read the Docs](http://pypiper.readthedocs.org/). There you will find:
-
-* [Hello World](http://pypiper.readthedocs.io/en/latest/hello-world.html)
-* [Tutorials](http://pypiper.readthedocs.io/en/latest/tutorials.html)
-* [API](http://pypiper.readthedocs.io/en/latest/api.html)
-* A list of public pipelines that use pypiper.
-* and more!
-
-# Install
-
-```
-pip install --user piper
-```
-
-Update with:
-
-```
-pip install --user --upgrade piper
-```
+A lightweight python toolkit for gluing together restartable, robust command line pipelines. The best place to learn more is at the [documentation hosted at Read the Docs](http://pypiper.readthedocs.org/).
diff --git a/doc/source/_static/logo_pypiper.svg b/doc/source/_static/logo_pypiper.svg
diff --git a/doc/source/features.rst b/doc/source/features.rst
@@ -1,5 +1,6 @@
+.. |logo| image:: _static/logo_pypiper.svg
 
-Features at-a-glance
+|logo| Features at-a-glance
 =========================
 
 .. |error| image:: _static/error.svg

diff --git a/doc/source/hello-world.rst b/doc/source/hello-world.rst
@@ -1,4 +1,6 @@
-Installing and Hello World
+.. |logo| image:: _static/logo_pypiper.svg
+
+|logo| Installing and Hello World
 ==============================
 
 Release versions are posted on the GitHub `releases page <https://github.com/epigen/pypiper/releases>`_. You can also install the latest version directly from pypi (under the name ``piper``) using pip:

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -1,6 +1,7 @@
+.. |logo| image:: _static/logo_pypiper.svg
 
-Welcome
-^^^^^^^^
+|logo| Pypiper
+^^^^^^^^^^^^^^
 
 Pypiper is a lightweight python toolkit that helps you write slick pipelines in python. It takes your current pipeline (e.g. shell script) and improves it with minimal effort. You'll be running in minutes.
 

diff --git a/doc/source/intro.rst b/doc/source/intro.rst
@@ -1,5 +1,6 @@
+.. |logo| image:: _static/logo_pypiper.svg
 
-Introduction
+|logo| Introduction
 =========================
 
 Pypiper is a lightweight python toolkit for gluing together restartable command