Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

# -- Project information -----------------------------------------------------

project = 'pyranges'
project = 'pyranges0'
copyright = '2023, Endre Bakken Stovner and Marco Mariotti'
author = 'Endre Bakken Stovner and Marco Mariotti'

Expand Down Expand Up @@ -53,6 +53,7 @@
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
html_title = 'pyranges0'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand Down
11 changes: 9 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,22 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

The PyRanges documentation
==========================
The pyranges0 documentation
===========================
PyRanges is a Python library specifically designed for efficient and intuitive manipulation of genomics data,
particularly genomic intervals (like genes, genomic features, or reads).
The library is optimized for fast querying and manipulation of genomic annotations.

PyRanges is open source, and hosted at GitHub: https://github.com/pyranges/pyranges0


Deprecation note
~~~~~~~~~~~~~~~~

This repo currently hosts the "version 0" of pyranges. A redesigned, faster version 1 is available at https://github.com/pyranges/pyranges1
Version 1 will soon replace version 0. We encourage existing v0 users to migrate to v1 (see guide at https://pyranges1.readthedocs.io/en/latest/migration_guide.html), and new users to directly adopt v1. Read about v1 in our preprint at https://doi.org/10.64898/2025.12.11.693639


Citation
~~~~~~~~

Expand Down
Loading