Skip to content

Commit

Permalink
docs: Fix markdown links
Browse files Browse the repository at this point in the history
Update markdown links to comply with what appears to be a stricter
rendering engine recently introduced on github.com
  • Loading branch information
ctsa committed Mar 21, 2017
1 parent 3bcd52d commit f3e8bd5
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 13 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
pyFlow - a lightweight parallel task engine
===========================================

[![Build Status] [tcistatus]] [tcihome]
[![Build status] [acistatus]] [acihome]
[![Build Status][tcistatus]][tcihome]
[![Build status][acistatus]][acihome]


pyFlow is a tool to manage tasks in the context of a task dependency
graph. It has some similarities to make. pyFlow is not a program – it
is a python module, and workflows are defined using pyFlow by writing
regular python code with the pyFlow API

For more information, please see the [pyFlow website] [site].
For more information, please see the [pyFlow website][site].

[site]:http://illumina.github.io/pyflow/

Expand All @@ -24,8 +24,7 @@ For more information, please see the [pyFlow website] [site].
License
-------

pyFlow source code is provided under the [BSD 2-Clause License]
(pyflow/COPYRIGHT.txt).
pyFlow source code is provided under the [BSD 2-Clause License](pyflow/COPYRIGHT.txt).


Releases
Expand Down
16 changes: 8 additions & 8 deletions pyflow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ relative priorities to be run or queued first.
LICENSE:
--------

pyFlow source code is provided under the [BSD 2-Clause License] (COPYRIGHT.txt).
pyFlow source code is provided under the [BSD 2-Clause License](COPYRIGHT.txt).

INSTALL:
--------
Expand All @@ -53,7 +53,7 @@ The pyflow module can be installed using standard python distutils
intallation. To do so unpack the tarball and use the setup script
as follows:

```
```bash
tar -xzf pyflow-X.Y.Z.tar.gz
cd pyflow-X.Y.Z
python setup.py build install
Expand All @@ -63,7 +63,7 @@ If installation in not convenient, you can simply add the pyflow
src/ directory to the system search path. For instance:

usepyflow.py:
```
```python
import sys
sys.path.append("/path/to/pyflow/src")

Expand Down Expand Up @@ -142,8 +142,8 @@ from make and must be kept in mind when restarting interrupted
workflows.

The runstate of each task is in
pyflow.data/state/pyflow_tasks_runstate.txt, the description of each
task is in pyflow.data/state/pyflow_tasks_info.txt. At the beginning of
`pyflow.data/state/pyflow_tasks_runstate.txt`, the description of each
task is in `pyflow.data/state/pyflow_tasks_info.txt`. At the beginning of
each run any existing task files are backed up in
pyflow.data/state/backup.

Expand Down Expand Up @@ -171,14 +171,14 @@ task dependencies, where each node colored by the task status. The graph
generation script is automatically created for each run in the pyflow state
directory here:

pyflow.data/state/make_pyflow_task_graph.py
pyflow.data/state/make_pyflow_task_graph.py

This script can be run without arguments to produce the current task graph in
dot format based on the data files in the pyflow.data/state/ directory.
dot format based on the data files in the `pyflow.data/state/` directory.

#### Site configuration:

The file ${pyflowDir}/src/pyflowConfig.py contains any pyflow variables or
The file `${pyflowDir}/src/pyflowConfig.py` contains any pyflow variables or
functions which would be likely to need configuration at a new site. This
currently incudes:

Expand Down

0 comments on commit f3e8bd5

Please sign in to comment.