Fix doc issue for utilities part on the web site

git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@3176 636b058d-ea47-450e-bf9e-a15bfbe3eedb

Former-commit-id: 3bafd9e13a5646ca93023144705d3ac7ed7c9b3a

1 files changed, 32 insertions, 10 deletions

diff --git a/src/Bitmap_cubical_complex/utilities/README b/src/Bitmap_cubical_complex/utilities/README
index ddff7034..393b2654 100644
--- a/src/Bitmap_cubical_complex/utilities/README
+++ b/src/Bitmap_cubical_complex/utilities/README
@@ -1,18 +1,40 @@
-# Bitmap_cubical_complex #

+---

+layout: page

+title: "Bitmap cubical complex"

+meta_title: "cubicalcomplex"

+subheadline: ""

+teaser: ""

+permalink: "/cubicalcomplex/"

+---

+{::comment}

+These flags above are here for web site generation, please let them.

+cf. https://gitlab.inria.fr/GUDHI/website

+Must be in conformity with _data/navigation.yml

+{:/comment}

 

-## `cubical_complex_persistence` ##

-This program computes persistent homology, by using the Bitmap_cubical_complex class, of cubical complexes provided in text files in Perseus style. See [here](http://gudhi.gforge.inria.fr/doc/latest/fileformats.html#FileFormatsPerseus) for a description of the file format.

 

-Example:

+## cubical_complex_persistence ##

+This program computes persistent homology, by using the Bitmap_cubical_complex class, of cubical complexes provided in text files in Perseus style.

+See [here](http://gudhi.gforge.inria.fr/doc/latest/fileformats.html#FileFormatsPerseus) for a description of the file format.

 

-* Create a Cubical Complex from the Perseus style file `CubicalTwoSphere.txt`, computes Persistence cohomology from it and writes the results in a persistence file `CubicalTwoSphere.txt_persistence`:

-`cubical_complex_persistence data/bitmap/CubicalTwoSphere.txt`

+**Example**

 

-## `periodic_cubical_complex_persistence` ##

+```

+   cubical_complex_persistence data/bitmap/CubicalTwoSphere.txt

+```

+

+* Creates a Cubical Complex from the Perseus style file `CubicalTwoSphere.txt`,

+computes Persistence cohomology from it and writes the results in a persistence file `CubicalTwoSphere.txt_persistence`.

+

+## periodic_cubical_complex_persistence ##

 

 Same as above, but with periodic boundary conditions.

 

-Example:

+**Example**

+

+```

+   periodic_cubical_complex_persistence data/bitmap/3d_torus.txt

+```

 

-* Create a Periodical Cubical Complex from the Perseus style file `3d_torus.txt`, computes Persistence cohomology from it and writes the results in a persistence file `3d_torus.txt_persistence`:

-`periodic_cubical_complex_persistence data/bitmap/3d_torus.txt`

+* Creates a Periodical Cubical Complex from the Perseus style file `3d_torus.txt`,

+computes Persistence cohomology from it and writes the results in a persistence file `3d_torus.txt_persistence`.