Skip to content
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

Re-add schema to README #838

Merged
merged 3 commits into from
Oct 24, 2022
Merged

Re-add schema to README #838

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1cccc59
Re-add schema to README
flying-sheep Oct 19, 2022
40a9589
Fix readme inclusion
flying-sheep Oct 19, 2022
211340b
use URL instead of path in README so PyPI can render it
flying-sheep Oct 19, 2022
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
14 changes: 11 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,23 @@
.. |Coverage| image:: https://codecov.io/gh/scverse/anndata/branch/master/graph/badge.svg?token=IN1mJN1Wi8
:target: https://codecov.io/gh/scverse/anndata

.. 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

.. 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 <https://github.com/scverse/anndata>`_.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only “issue” with this PR is that this list item is quite redundant in the README.

However, only adding it to the docs index and includeing the rest of the bullet points would create two bullet lists.

* Read the `documentation <https://anndata.readthedocs.io>`_.
* Ask questions on the `scverse Discourse <https://discourse.scverse.org>`_.
* 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
* Consider citing the `anndata paper <https://doi.org/10.1101/2021.12.16.473007>`__.
* See `Scanpy's documentation <https://scanpy.readthedocs.io/>`__ for usage
related to single cell data. anndata was initially built for Scanpy.
16 changes: 5 additions & 11 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <https://github.com/scverse/anndata>`_.
* Ask questions on the `scverse Discourse <https://discourse.scverse.org>`_.
* Install via `pip install anndata` or `conda install anndata -c conda-forge`.
* Consider citing the `anndata paper <https://doi.org/10.1101/2021.12.16.473007>`__.
* See `Scanpy's documentation <https://scanpy.readthedocs.io/>`__ for usage
related to single cell data. anndata was initially built for Scanpy.
.. include:: ../README.rst
:start-after: .. after image

News
----
Expand Down