Skip to content

Commit

Permalink
Merge branch 'master' into reorg-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ivirshup committed Jun 27, 2021
2 parents dcdc01c + d3e6e42 commit dda22f3
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Import Scanpy as::
import scanpy as sc

.. note::
Wrappers to external functionality are found in :mod:`scanpy.external`.
Additional functionality is available in the broader :doc:`ecosystem <../ecosystem>`, with some tools being wrapped in the :mod:`scanpy.external` module.

Preprocessing: `pp`
-------------------
Expand Down
26 changes: 26 additions & 0 deletions docs/community.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Community
=========

Scanpy is a community driven project. There are multiple channels for users and developers to communicate and connect.

Discourse_
----------

The Scanpy Discourse forum is place to go to ask usage questions and for longer form discussions around the project.

.. _Discourse: https://scanpy.discourse.group

`Github Issue Tracker <https://github.com/theislab/scanpy/issues>`_
-------------------------------------------------------------------

The `Scanpy <https://github.com/theislab/scanpy/issues>`_ and `anndata <https://github.com/theislab/anndata/issues>`_ issue trackers are for reports and discussion of:

* Bug reports
* Documentation issues
* Feature requests

Developer Slack
---------------

We also have a private slack workspace for discussion of development of Scanpy and tools in the broader ecosystem.
If you'd like to request an invite, `please fill out this form <https://forms.gle/tiLpC7koSVbxFCYr5>`_.
5 changes: 4 additions & 1 deletion docs/ecosystem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,11 @@ Ecosystem
.. role:: small
.. role:: smaller

With *ecosystem*, we mean single-cell related tools that operate on :class:`~anndata.AnnData`. Here, we list some that do not have an interface in the :doc:`external API <external>`.
.. note::
If you'd like to see your tool included here, please open a `pull request <https://github.com/theislab/scanpy>`_!

With *ecosystem*, we mean the broader single-cell related tools that operate on :class:`~anndata.AnnData`.
If your tool doesn't do this, but is useful for analysing single cell data we also accept light wrappers for some tools in :mod:`scanpy.external`.

Viewers
-------
Expand Down
6 changes: 5 additions & 1 deletion docs/external.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,15 @@ External API
.. module:: scanpy.external
.. currentmodule:: scanpy.external

.. note::
More tools that integrate well with scanpy and anndata can be found on the :doc:`ecosystem page <../ecosystem>`.

Import Scanpy's wrappers to external tools as::

import scanpy.external as sce

If you'd like to see your tool included here, please open a `pull request <https://github.com/theislab/scanpy>`_!
If you'd like to include a tool here, consider making a pull request (:doc:`instructions <../dev/external-tools>`).
If the tool already uses `scanpy` or `anndata`, it may fit better in the :doc:`ecosystem page <../ecosystem>`.

Preprocessing: PP
------------------
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ Latest additions
external
ecosystem
release-notes/index
community
news
dev/index
contributors
Expand Down
1 change: 1 addition & 0 deletions docs/release-notes/1.8.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@

.. rubric:: Documentation

- Added :doc:`/community` page to docs :pr:`1856` :smaller:`I Virshup`
- Clarified docs issues for :func:`~scanpy.pp.neighbors`,
:func:`~scanpy.tl.diffmap`, :func:`~scanpy.pp.calculate_qc_metrics` :pr:`1680` :smaller:`G Palla`
- Integrated DocSearch_, a find-as-you-type documentation index search. :pr:`1754` :smaller:`P Angerer`
Expand Down

0 comments on commit dda22f3

Please sign in to comment.