Skip to content

Commit

Permalink
Update docs to add info on stable versions (#49)
Browse files Browse the repository at this point in the history
  • Loading branch information
trappitsch authored Aug 23, 2022
1 parent 45db332 commit 9e52e98
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ Package installation
pip install rimseval
Add ``--pre`` flag for pre-releases or install the latest version from GitHub.
If pre-releases are available and you would like to install one,
add the ``--pre`` flag to above command.
More information in the
`documentation <https://rimseval.readthedocs.io/en/latest/>`_.

Expand Down
6 changes: 6 additions & 0 deletions docs/gui/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,12 @@ you can simply type:
git pull
git install -r requirements.txt --upgrade
.. note:: Newer versions of the GUI can depend on development versions
of ``rimseval``. This means that you might see unexpected and wrong behavior.
The packaging tool of the GUI does not allow for specifically labeling of such versions.
Therefore, it is up to he user to ensure that you have the version that you like.
New versions that depend on development versions of ``rimseval`` will always be labeled
on GitHub as pre-releases. They will therefore not show up in the update reminder of the software.

------
Python
Expand Down

0 comments on commit 9e52e98

Please sign in to comment.