diff --git a/docs/conf.py b/docs/conf.py index 930c3c44..7b3a8e23 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -8,12 +8,17 @@ import os import sys +import tomllib sys.path.insert(0, os.path.abspath('../pygem/')) +# source pyproject.toml to get release +with open("../pyproject.toml", "rb") as f: + pyproject = tomllib.load(f) + project = 'PyGEM' copyright = '2023, David Rounce' author = 'David Rounce' -release = '1.0.1' +release = pyproject["tool"]["poetry"]["version"] # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration diff --git a/docs/install_pygem.md b/docs/install_pygem.md index ac1c4cb1..f1e28dbd 100644 --- a/docs/install_pygem.md +++ b/docs/install_pygem.md @@ -10,7 +10,7 @@ Next, choose your preferred PyGEM installation option:
(stable_install_target)= ## Stable install -The simplest **stable** installation method is to use an environment file. Right-click and save PyGEM's recommended environment file from [this link](https://github.com/PyGEM-Community/PyGEM/tree/master/docs/pygem_env.yml). +The simplest **stable** installation method is to use an environment file. Right-click and save PyGEM's recommended environment file from [this link](https://raw.githubusercontent.com/PyGEM-Community/PyGEM/refs/heads/master/docs/pygem_environment.yml). From the folder where you saved the file, run `conda env create -f pygem_environment.yml`. ```{note} @@ -41,4 +41,4 @@ initialize ``` # Demonstration Notebooks -A series of accompanying Jupyter notebooks has been produced for demonstrating the functionality of PyGEM. These are hosted in the [PyGEM-notebooks repository](https://github.com/PyGEM-Community/PyGEM-notebooks). \ No newline at end of file +A series of accompanying Jupyter notebooks has been produced for demonstrating the functionality of PyGEM. These are hosted in the [PyGEM-notebooks repository](https://github.com/PyGEM-Community/PyGEM-notebooks).