Skip to content

Commit 8474603

Browse files
committed
feat(Update bioconda.rst and conf.py): Use placeholder for version in installation instructions
1 parent 96ee67f commit 8474603

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

docs/src/conf.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,3 +93,9 @@
9393
# Sitemap settings
9494
html_baseurl = 'https://ecogenomics.github.io/GTDBTk/'
9595
sitemap_url_scheme = "{link}"
96+
97+
# Make version info available for substitution in RST files
98+
rst_epilog = f"""
99+
.. |release| replace:: {release}
100+
.. |version| replace:: {version}
101+
"""

docs/src/installing/bioconda.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ specify those channels in that order!
2222

2323
.. code-block:: bash
2424
25-
# NOTE: replace 2.1.1 with the version you wish to install
25+
# NOTE: replace |release| with the version you wish to install
2626
2727
# using conda
28-
conda create -n gtdbtk-2.1.1 -c conda-forge -c bioconda gtdbtk=2.1.1
28+
conda create -n gtdbtk-|release| -c conda-forge -c bioconda gtdbtk=|release|
2929
3030
# using mamba (alternative)
31-
mamba create -n gtdbtk-2.1.1 -c conda-forge -c bioconda gtdbtk=2.1.1
31+
mamba create -n gtdbtk-|release| -c conda-forge -c bioconda gtdbtk=|release|
3232
3333
Step 3: Download and alias the GTDB-Tk reference data
3434
-----------------------------------------------------
@@ -57,7 +57,7 @@ You can automatically alias ``GTDBTK_DATA_PATH`` whenever the environment is act
5757
.. code-block:: bash
5858
5959
# Activate the GTDB-Tk conda environment
60-
conda activate gtdbtk-2.1.1
60+
conda activate gtdbtk-|release|
6161
6262
# Set the environment variable to the directory containing the GTDB-Tk reference data
6363
conda env config vars set GTDBTK_DATA_PATH="/path/to/unarchived/gtdbtk/data";

0 commit comments

Comments
 (0)