diff --git a/docs/installation.rst b/docs/installation.rst index 82b9555..da6f4a1 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -30,7 +30,9 @@ You can build the package by running the following command: :: $ docker build -t cbica/nichart_dlmuse . -.. _`Singularity/Apptainer build` +*************************** +Singularity/Apptainer build +*************************** Singularity and Apptainer images can be built for NiChart_DLMUSE, allowing for frozen versions of the pipeline and easier installation for end-users. Note that the Singularity project recently underwent a rename to "Apptainer", with a commercial @@ -43,7 +45,9 @@ After installing the container engine, run: :: This will take some time, but will build a containerized version of your current repo. Be aware that this includes any local changes! The nichart_dlmuse.sif file can be distributed via direct download, or pushed to a container registry that accepts SIF images. -.. _`Manual installation` +******************* +Manual installation +******************* You can manually build the package from source by running: :: @@ -51,5 +55,6 @@ You can manually build the package from source by running: :: $ cd NiChart_DLMUSE && python3 -m pip install -e . -We **do not** recomment installing the package directly from source as the repository above is under heavy development and can cause -crashes and bugs. +.. note:: + We **do not** recommend installing the package directly from source as the repository above is under heavy development and can cause + crashes and bugs.