From eeaf0e8cb80ac112d6f14e47c5589d5f25635a2e Mon Sep 17 00:00:00 2001 From: Anthony Lim Date: Tue, 16 Jan 2024 16:37:10 +0000 Subject: [PATCH] refs #87 doc tidy up --- docs/source/install.rst | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/docs/source/install.rst b/docs/source/install.rst index cfb12ff0..3e725b04 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -1,25 +1,19 @@ Installation ============ -This package provides a convenient API -for performing Bayesian analysis -on muon and neutron-scattering data. +The library is available on :ref:`PyPi` and can be installed with pip: -## Installing +.. code-block:: python -The library is available on [PyPi](https://pypi.org/project/quickBayes/#description) and can be installed with pip: - -```sh -> python -m pip install quickBayes -``` + python -m pip install quickBayes Reporting Issues ================ -To report an issue please create a [github issue](https://github.com/ISISNeutronMuon/quickBayes/issues) with the details of the bug. +To report an issue please create a :ref:`github issue` with the details of the bug. Support ======= -Support will be provided via [github issues](https://github.com/ISISNeutronMuon/quickBayes/issues), please outline the problem in a new issue. +Support will be provided via :ref:`github issues`, please outline the problem in a new issue.