Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/install_pygem.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Next, choose your preferred PyGEM installation option:<br>

(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}
Expand Down Expand Up @@ -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).
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).