Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Doc tidy up #88

Merged
merged 3 commits into from
Feb 29, 2024
Merged

Doc tidy up #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
42f2bc5
refs #87 doc tidy up
AnthonyLim23 Jan 16, 2024
eeaf0e8
refs #87 doc tidy up
AnthonyLim23 Jan 16, 2024
488e262
refs #87 doc tidy up
AnthonyLim23 Jan 16, 2024
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
1 change: 1 addition & 0 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Contents
:caption: Contents:

Introduction <intro>
Installation and support <install>
Fitting <fitting/index>
loglikelihood
Workflows <workflows/index>
Expand Down
19 changes: 19 additions & 0 deletions docs/source/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Loading