Skip to content

Commit 4c8a25a

Browse files
committed
Fine tuning documentation changes.
1 parent d491a76 commit 4c8a25a

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
# -- Project information -----------------------------------------------------
2121

2222
project = 'iGUIDE'
23-
copyright = '2024, Christopher Nobles, Ph.D.'
23+
copyright = '2024, Christopher Nobles, Ph.D'
2424
author = 'Christopher Nobles, Ph.D.'
2525

2626
# The short X.Y version

docs/usage.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -443,18 +443,18 @@ Manual Install
443443
Skip to installing iGUIDE if you already have miniconda or anaconda installed.
444444
These can be executed in your home directory.
445445

446-
Get the latest version of miniconda install script.::
446+
Get the latest version of miniconda install script::
447447

448448
__conda_url=https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh
449449
wget -q ${__conda_url} -O miniconda.sh
450450

451451
Installing miniconda through downloaded script. You can choose a different path
452-
for the install, here it is installed into the home directory.::
452+
for the install, here it is installed into the home directory::
453453

454454
__conda_path="~/miniconda3"
455455
bash miniconda.sh -b -p ${__conda_path}
456456

457-
Source conda to activate the installation for use.::
457+
Source conda to activate the installation for use::
458458
459459
source ${__conda_path}/etc/profile.d/conda.sh
460460

@@ -464,20 +464,20 @@ The following commands should be called from within the iGUIDE directory
464464

465465
Install the conda environment from the requirements file. The name field here
466466
can be changed to what you would like to call the environment, default for the
467-
install script is 'iguide'.::
467+
install script is 'iguide'::
468468

469469
conda create --name=iguide --quiet --yes --file etc/build.b1.0.1.txt
470470

471471
After successful creation of the environment, activate the iguide environment (or what
472-
you've named it).::
472+
you've named it)::
473473

474474
conda activate iguide
475475

476-
Install the supporting R-package into the environment.::
476+
Install the supporting R-package into the environment::
477477

478478
R CMD INSTALL tools/iguideSupport
479479

480-
Setup your environmental variables.::
480+
Setup your environmental variables::
481481

482482
__iguide_dir=$(pwd)
483483

@@ -490,38 +490,38 @@ Setup your environmental variables.::
490490
${CONDA_PREFIX}/etc/conda/deactivate.d/env_vars.sh
491491

492492
You should now deactivate and reactivate the environment to initiate the environmental
493-
variables.::
493+
variables::
494494

495495
conda deactivate
496496
conda activate iguide
497497

498-
Lastely, install the command line interface for iGUIDE using pip.::
498+
Lastely, install the command line interface for iGUIDE using `pip`::
499499
500500
pip install --upgrade tools/iguidelib/
501501

502502
**Testing**
503503
Test to make sure the components were installed correctly.
504504

505-
Test for required R-packages installed.::
505+
Test for required R-packages installed::
506506

507507
$(Rscript tools/rscripts/check_for_required_packages.R &> /dev/null) && echo true || echo false
508508

509-
Check to make sure iguideSupport was installed correctly.::
509+
Check to make sure iguideSupport was installed correctly::
510510

511511
$(Rscript tools/rscripts/check_pkgs.R iguideSupport &> /dev/null) && echo true || echo false
512512

513-
Run unit tests for iguideSupport.::
513+
Run unit tests for iguideSupport::
514514

515515
`$(Rscript tools/rscripts/check_iguideSupport.R &> /dev/null) && echo true || echo false'
516516

517-
Check to make sure the pip install of the CLI was successful.::
517+
Check to make sure the pip install of the CLI was successful::
518518

519519
command -v iguide &> /dev/null && echo true || echo false
520520

521521
Run tests for iGUIDE, this step will take a little bit to complete if it starts processing
522522
the test case. Go grab a coffee, you deserve it getting to this point. :) The test will
523523
activate the environment as part of the test, so you should deactivate your environment
524-
first and then initiate the test.::
524+
first and then initiate the test::
525525

526526
conda deactivate
527527
bash etc/tests/test.sh iguide

0 commit comments

Comments
 (0)