diff --git a/docs/conf.py b/docs/conf.py index fc9236a..a7e3d99 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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' @@ -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, diff --git a/docs/index.rst b/docs/index.rst index 47d16c7..59c87fd 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,8 +3,8 @@ 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. @@ -12,6 +12,13 @@ The library is optimized for fast querying and manipulation of genomic annotatio 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 ~~~~~~~~