Doc tidy up (#88)

* refs #87 doc tidy up * refs #87 doc tidy up * refs #87 doc tidy up
ISISNeutronMuon · Feb 29, 2024 · e7843f9 · e7843f9
1 parent 7b6a094
commit e7843f9
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -12,6 +12,6 @@ The library is available on [PyPi](https://pypi.org/project/quickBayes/#descript
 > python -m pip install quickBayes
 ```
 
-The user documentation is `here <https://quickbayes.readthedocs.io/en/latest/>`.
+The user documentation is [here](https://quickbayes.readthedocs.io/en/latest/).
 
-The developer documentation is `here <https://quickbayes.readthedocs.io/en/latest/dev/index.html>`.
+The developer documentation is [here](https://quickbayes.readthedocs.io/en/latest/dev/index.html).
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -14,6 +14,7 @@ Contents
    :caption: Contents:
 
    Introduction <intro>
+   Installation and support <install>
    Fitting <fitting/index>
    loglikelihood
    Workflows <workflows/index>

diff --git a/docs/source/install.rst b/docs/source/install.rst
@@ -0,0 +1,19 @@
+Installation
+============
+
+The library is available on `PyPi<https://pypi.org/project/quickBayes/#description>` and can be installed with pip:
+
+.. code-block:: python
+
+    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.
+
+
+Support
+=======
+
+Support will be provided via `github issues<https://github.com/ISISNeutronMuon/quickBayes/issues>`, please outline the problem in a new issue.