Skip to content

DOC: point README to documentation website #121

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

Merged
merged 4 commits into from
Dec 2, 2024
Merged

DOC: point README to documentation website #121

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
776721a
DOC: point README to documentation website
rmcar17 Dec 2, 2024
c0d6df9
Merge branch 'main' into link-readme-to-docs
rmcar17 Dec 2, 2024
69a1022
Merge branch 'main' into link-readme-to-docs
rmcar17 Dec 2, 2024
6e2d501
Merge branch 'main' into link-readme-to-docs
rmcar17 Dec 2, 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
7 changes: 3 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,10 @@
[![Coverage Status](https://coveralls.io/repos/github/iqtree/piqtree2/badge.svg?branch=main)](https://coveralls.io/github/iqtree/piqtree2?branch=main)
[![Documentation Status](https://readthedocs.org/projects/piqtree2/badge/?version=latest)](https://piqtree2.readthedocs.io/en/latest/?badge=latest)

`piqtree2` is a library which allows you use IQ-TREE directly from Python! The interface with python is through [cogent3](https://cogent3.org) objects, as shown below.
`piqtree2` is a library which allows you use IQ-TREE directly from Python! The interface with python is through [cogent3](https://cogent3.org) objects.
For usage, please refer to the [documentation](https://piqtree2.readthedocs.io/) or the examples below.

## Note

This project is still in early development, if you encounter any problems or have any feature requests feel free to raise an [issue](https://github.com/iqtree/piqtree2/issues)!
If you encounter any problems or have any feature requests feel free to raise an [issue](https://github.com/iqtree/piqtree2/issues)!

## Examples

Expand Down