From c475805da8c565ec54d00fec97cf3e7f448b7477 Mon Sep 17 00:00:00 2001 From: Roberto Rossini <71787608+robomics@users.noreply.github.com> Date: Mon, 29 Jan 2024 22:34:25 +0100 Subject: [PATCH] Update docs --- docs/conf.py | 2 +- docs/installation.rst | 6 +++--- docs/installation_src.rst | 2 +- docs/quickstart_api.rst | 4 ++-- docs/quickstart_cli.rst | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index c68bff97..7ae6e79c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -49,7 +49,7 @@ # built documents. # Read the listed version -version = "0.0.7" +version = "0.0.8" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/installation.rst b/docs/installation.rst index ff8df523..04045cb6 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -20,7 +20,7 @@ hictk package for Linux and MacOS is available on bioconda and can be installed hictk: /home/user/.miniconda3/envs/hictk/bin/hictk (hictk) user@dev:/tmp$ hictk --version - hictk-v0.0.7-bioconda + hictk-v0.0.8-bioconda Containers (Docker or Singularity/Apptainer) @@ -66,10 +66,10 @@ Downloading and running the latest stable release can be done as follows: .. code-block:: console # Using Docker, may require sudo - user@dev:/tmp$ docker run ghcr.io/paulsengroup/hictk:0.0.7 --help + user@dev:/tmp$ docker run ghcr.io/paulsengroup/hictk:0.0.8 --help # Using Singularity/Apptainer - user@dev:/tmp$ singularity run ghcr.io/paulsengroup/hictk:0.0.7 --help + user@dev:/tmp$ singularity run ghcr.io/paulsengroup/hictk:0.0.8 --help Blazing fast tools to work with .hic and .cool files. Usage: /usr/local/bin/hictk [OPTIONS] SUBCOMMAND diff --git a/docs/installation_src.rst b/docs/installation_src.rst index a3cc115f..db1a67a3 100644 --- a/docs/installation_src.rst +++ b/docs/installation_src.rst @@ -71,7 +71,7 @@ Using git. git clone https://github.com/paulsengroup/hictk.git /tmp/hictk cd /tmp/hictk - git checkout v0.0.7 # Skip this step if you want to build the latest commit from main + git checkout v0.0.8 # Skip this step if you want to build the latest commit from main Compiling hictk --------------- diff --git a/docs/quickstart_api.rst b/docs/quickstart_api.rst index 47d2bc50..c3600b42 100644 --- a/docs/quickstart_api.rst +++ b/docs/quickstart_api.rst @@ -18,7 +18,7 @@ To install libhictk using Conan, first create a conanfile.txt like the following .. code-block:: [requires] - hictk/0.0.7 + hictk/0.0.8 [generators] CMakeDeps @@ -62,7 +62,7 @@ To install and configure hictk using `FetchContent