diff --git a/.readthedocs.yml b/.readthedocs.yml index 4cb6d9fe..f1266aaf 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -8,7 +8,7 @@ version: 2 build: os: ubuntu-22.04 tools: - python: "3.11" + python: "3.12" # Build documentation in the "docs/" directory with Sphinx sphinx: diff --git a/README.rst b/README.rst index 6eebc802..5c493925 100644 --- a/README.rst +++ b/README.rst @@ -97,24 +97,29 @@ Main features Installation or upgrade ----------------------- -Installation instructions are available on the `main web site -`_ -for this package. +To install `uncertainties`, use:: + pip install uncertainties + +To upgrade from an older version, use:: + + pip install --upgrade uncertainties + +Further details are in the `on-line documentation +`_. Git branches ------------ -The ``release`` branch is the latest stable release. It should pass the tests. - -``master*`` branches in the Github repository are bleeding-edge, and do not -necessarily pass the tests. The ``master`` branch is the latest, relatively -stable versions (while other ``master*`` branches are more experimental). +The GitHub ``master`` branch is the latest development version. It should +represent a stable pre-release and should pass the tests, but will be more +experimental. Tagged releases will be available on GitHub, and correspond to +the releases to PyPI. The GitHub ``gh-pages`` branch will contain a stable +version of the documentation that can be viewed at +`_ in 2024. -.. _Python: http://docs.python.org/tutorial/interpreter.html -.. _IPython: http://ipython.readthedocs.io/en/stable/ -.. _math: http://docs.python.org/library/math.html -.. _error propagation theory: http://en.wikipedia.org/wiki/Propagation_of_uncertainty -.. _main website: http://uncertainties-python-package.readthedocs.io/ +.. _IPython: https://ipython.readthedocs.io/en/stable/ +.. _math: https://docs.python.org/library/math.html +.. _error propagation theory: https://en.wikipedia.org/wiki/Propagation_of_uncertainty +.. _main website: https://uncertainties.readthedocs.io/ diff --git a/pyproject.toml b/pyproject.toml index 6c189f17..b865e92b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -55,7 +55,7 @@ packages = ["uncertainties", "uncertainties.unumpy"] [tool.setuptools_scm] [project.urls] -Documentation = "http://uncertainties-python-package.readthedocs.io/" +Documentation = "https://uncertainties.readthedocs.io/" Repository = "https://github.com/lmfit/uncertainties" Issues = "https://github.com/lmfit/uncertainties/issues" Changelog = "https://github.com/lmfit/uncertainties/blob/master/CHANGES.rst"