Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
robomics committed Jan 29, 2024
1 parent e839f74 commit c475805
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/installation_src.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------
Expand Down
4 changes: 2 additions & 2 deletions docs/quickstart_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -62,7 +62,7 @@ To install and configure hictk using `FetchContent <https://cmake.org/cmake/help
FetchContent_Declare(
hictk
GIT_REPOSITORY "https://github.com/paulsengroup/hictk.git"
GIT_TAG v0.0.7
GIT_TAG v0.0.8
SYSTEM)
# Customize hictk build flags
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart_cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Next, verify that hictk was installed correctly with:
.. code-block:: console
user@dev:/tmp$ hictk --version
hictk-v0.0.7
hictk-v0.0.8
Command line interface
======================
Expand Down

0 comments on commit c475805

Please sign in to comment.