Skip to content

Commit 8cdbc4a

Browse files
committed
Improve technical instruction #230\n Add -version flag #204
1 parent d466daf commit 8cdbc4a

8 files changed

Lines changed: 246 additions & 55 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,16 @@ Whalen, A, Ros-Freixedes, R, Wilson, DL, Gorjanc, G, Hickey, JM. (2018). Hybrid
1212

1313
See https://alphapeel.readthedocs.io/en/latest
1414

15+
Quick links:
16+
17+
- [Installation](https://alphapeel.readthedocs.io/en/latest/get_started.html#install-software)
18+
19+
- [Simple example](https://alphapeel.readthedocs.io/en/latest/get_started.html#an-example)
20+
21+
- [How to use](https://alphapeel.readthedocs.io/en/latest/usage.html)
22+
23+
- [Algorithm](https://alphapeel.readthedocs.io/en/latest/algorithm.html)
24+
1525
## Conditions of use
1626

1727
AlphaPeel is fully and freely available for all use under the MIT License.

docs/source/algorithm.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _algorithm:
2+
13
==================
24
Algorithm Overview
35
==================

docs/source/changelog.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
=========
22
Changelog
33
=========
4-
[1.3.1] - 2026-03-05
5-
====================
4+
5+
..
6+
If you are add a new entry to the changelog, please follow the format of the existing entries and
7+
add your changes to the top of the file under the [Unreleased] section.
8+
Please also include the pull request number and the GitHub username(s) of the contributor(s) who made the change.
9+
10+
[Unreleased] - 2026-03-??
11+
=========================
612

713
New features
814
------------
@@ -25,16 +31,10 @@ Maintenance
2531

2632
- Reformatted the ``alt_allele_prob_file`` input to match the outputted ``alt_allele_prob_file``.
2733

28-
29-
[Unreleased] - 2026-02-12
30-
=========================
31-
32-
Maintenance
33-
-----------
34-
3534
* Updated the documentation to clarify inputs, outputs, and parameters
3635
(:pr:`219`, :user:`gregorgorjanc`).
3736

37+
3838
[1.3.0] - 2026-02-05
3939
====================
4040

0 commit comments

Comments
 (0)