From 1cccc597076d2833d54839441ad8cc214426f900 Mon Sep 17 00:00:00 2001 From: Philipp A Date: Wed, 19 Oct 2022 10:32:42 +0200 Subject: [PATCH 1/3] Re-add schema to README --- README.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 0e469f874..7291b8860 100644 --- a/README.rst +++ b/README.rst @@ -17,6 +17,9 @@ .. |Coverage| image:: https://codecov.io/gh/scverse/anndata/branch/master/graph/badge.svg?token=IN1mJN1Wi8 :target: https://codecov.io/gh/scverse/anndata +.. image:: docs/_static/img/anndata_schema.svg + :align: right + :width: 350px anndata - Annotated data ======================== @@ -26,6 +29,3 @@ anndata is a Python package for handling annotated data matrices in memory and o * Read the `documentation `_. * Ask questions on the `scverse Discourse `_. * Install via ``pip install anndata`` or ``conda install anndata -c conda-forge``. - -.. would be nice to have the schema also on GitHub, but it’s much too wide there, hence need to duplicate description -.. GitHub doesn’t plan to resolve scaling images: https://github.com/github/markup/issues/295 From 40a958950cfdc9c62e5a0aff383b6356a3bd88b2 Mon Sep 17 00:00:00 2001 From: Philipp A Date: Wed, 19 Oct 2022 11:30:44 +0200 Subject: [PATCH 2/3] Fix readme inclusion --- README.rst | 6 ++++++ docs/index.rst | 16 +++++----------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index 7291b8860..68ecaf89c 100644 --- a/README.rst +++ b/README.rst @@ -21,11 +21,17 @@ :align: right :width: 350px +.. after image + anndata - Annotated data ======================== anndata is a Python package for handling annotated data matrices in memory and on disk, positioned between pandas and xarray. anndata offers a broad range of computationally efficient features including, among others, sparse data support, lazy operations, and a PyTorch interface. +* Discuss development on `GitHub `_. * Read the `documentation `_. * Ask questions on the `scverse Discourse `_. * Install via ``pip install anndata`` or ``conda install anndata -c conda-forge``. +* Consider citing the `anndata paper `__. +* See `Scanpy's documentation `__ for usage + related to single cell data. anndata was initially built for Scanpy. diff --git a/docs/index.rst b/docs/index.rst index ef590eb83..3e23ec964 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,21 +1,15 @@ -.. include:: ../README.rst - :end-line: 22 - .. role:: small .. role:: smaller +.. include:: ../README.rst + :end-before: .. image + .. image:: _static/img/anndata_schema.svg :align: right :width: 40% -anndata is a Python package for handling annotated data matrices in memory and on disk, positioned between pandas and xarray. anndata offers a broad range of computationally efficient features including, among others, sparse data support, lazy operations, and a PyTorch interface. - -* Discuss development on `GitHub `_. -* Ask questions on the `scverse Discourse `_. -* Install via `pip install anndata` or `conda install anndata -c conda-forge`. -* Consider citing the `anndata paper `__. -* See `Scanpy's documentation `__ for usage - related to single cell data. anndata was initially built for Scanpy. +.. include:: ../README.rst + :start-after: .. after image News ---- From 211340b2858b47057478048f3c68250035311848 Mon Sep 17 00:00:00 2001 From: Philipp A Date: Wed, 19 Oct 2022 11:36:52 +0200 Subject: [PATCH 3/3] use URL instead of path in README so PyPI can render it --- README.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 68ecaf89c..a270a4976 100644 --- a/README.rst +++ b/README.rst @@ -17,7 +17,9 @@ .. |Coverage| image:: https://codecov.io/gh/scverse/anndata/branch/master/graph/badge.svg?token=IN1mJN1Wi8 :target: https://codecov.io/gh/scverse/anndata -.. image:: docs/_static/img/anndata_schema.svg +.. use URL instead of path here so PyPI can render it + +.. image:: https://raw.githubusercontent.com/scverse/anndata/master/docs/_static/img/anndata_schema.svg :align: right :width: 350px