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.

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

Doc overhaul #2220

Merged
merged 90 commits into from Feb 15, 2023
Merged
Show file tree
Hide file tree
Changes from 68 commits
Commits
Show all changes
90 commits
Select commit Hold shift + click to select a range
f797340
Update conf.py
adamgayoso Apr 5, 2022
75cc6a7
add req
adamgayoso Apr 5, 2022
fa3aa96
add override path
adamgayoso Apr 5, 2022
35a19f1
Create override.css
adamgayoso Apr 5, 2022
dd18bb4
add pygments, remove scvi-tools colors
adamgayoso Apr 5, 2022
60e7896
add myst extensions
adamgayoso Apr 5, 2022
321073f
remove github edit links
adamgayoso Apr 5, 2022
4407e63
move css
adamgayoso Apr 5, 2022
718cf25
add sphinx design, opengraph
adamgayoso Apr 5, 2022
b3ba47c
move contributors out of index
adamgayoso Apr 5, 2022
2412105
show source
adamgayoso Apr 5, 2022
9384aec
add submodule
adamgayoso Apr 5, 2022
0c1a9eb
add submodule
adamgayoso Apr 5, 2022
2756ebc
temp old tutorials rename
adamgayoso Apr 5, 2022
f64955b
remove github links
adamgayoso Apr 5, 2022
d1da3a1
remove github url from template
adamgayoso Apr 5, 2022
10c2317
disable warning fail
adamgayoso Apr 5, 2022
bed5798
disable warning fail
adamgayoso Apr 5, 2022
d1d5c44
nbsphinx
adamgayoso Apr 5, 2022
dada8ef
fix headings
adamgayoso Apr 5, 2022
e23a8d9
rtd use submodule
adamgayoso Apr 5, 2022
57da69d
add viewcode
adamgayoso Apr 5, 2022
40048a3
more headings fixes
adamgayoso Apr 5, 2022
0f0a487
tutorials index
adamgayoso Apr 5, 2022
77221d9
add nbsphinx ext
adamgayoso Apr 5, 2022
ec0be1b
remove sphinx pygments
adamgayoso Apr 5, 2022
3c6fe96
fix colab link
adamgayoso Apr 5, 2022
224d883
add ipython as docs req
adamgayoso Apr 5, 2022
0fdecfc
no signatures in tables
adamgayoso Apr 5, 2022
71bd1f2
make ci happy
adamgayoso Apr 5, 2022
5f9bc0b
Merge branch 'master' into furo
flying-sheep Apr 6, 2022
efddd1f
add sphinx design cards
adamgayoso Apr 6, 2022
f0c3f9d
break up api
adamgayoso Apr 6, 2022
e18f3de
fix icons
adamgayoso Apr 6, 2022
be82ade
link to new api index in card
adamgayoso Apr 6, 2022
f54da0f
update colors
adamgayoso Apr 6, 2022
d68de29
no latest release in index
adamgayoso Apr 6, 2022
2fc7995
release notes
adamgayoso Apr 6, 2022
548f977
colors
adamgayoso Apr 6, 2022
bde4372
color typo
adamgayoso Apr 6, 2022
e51bc8f
back to default colors
adamgayoso Apr 6, 2022
268899d
Update override.css
flying-sheep Apr 7, 2022
eb3d806
add module
adamgayoso Apr 7, 2022
c513f33
move external
adamgayoso Apr 7, 2022
e5ed810
Make border color override work
flying-sheep Apr 7, 2022
3172761
Merge branch 'master' into furo
adamgayoso Sep 14, 2022
89c607b
grid
adamgayoso Sep 14, 2022
abb4ab8
hoverxref and linkcode
adamgayoso Sep 14, 2022
cb091aa
fix grid
adamgayoso Sep 14, 2022
53c9ad1
comment
adamgayoso Sep 14, 2022
9af51ac
grid spacing
adamgayoso Sep 14, 2022
9f59cfd
intersphinx hoverxref
adamgayoso Sep 14, 2022
602645f
extlinks
adamgayoso Sep 14, 2022
a155640
extlinks
adamgayoso Sep 14, 2022
206f560
fix contributors
adamgayoso Sep 15, 2022
8531a37
fix tutorials to use old page
adamgayoso Sep 15, 2022
1cb82cc
hidden toc tree
adamgayoso Sep 15, 2022
0fe6201
toctree for tutorials hidden
adamgayoso Sep 15, 2022
30e7c5a
clean up conf
adamgayoso Sep 15, 2022
d24a4be
fix extlinks
adamgayoso Sep 15, 2022
634c762
tutorial extlink
adamgayoso Sep 15, 2022
388c56c
add leiden to docs build
adamgayoso Sep 15, 2022
27ac206
buttons
adamgayoso Sep 15, 2022
f711998
small role
adamgayoso Sep 15, 2022
8efc47b
try rst badge
adamgayoso Sep 15, 2022
8f2e06e
extlinks
adamgayoso Sep 15, 2022
0f1092a
fix image link
adamgayoso Sep 15, 2022
35ad3d1
Merge branch 'master' into furo
adamgayoso Jan 5, 2023
c25df19
Update docs/conf.py
adamgayoso Jan 8, 2023
dbbe178
update submodule
adamgayoso Jan 8, 2023
e208f40
remove hoverxref
adamgayoso Jan 8, 2023
394939a
warning code
adamgayoso Jan 8, 2023
f44a88d
add how to update submodule
adamgayoso Jan 8, 2023
c6f8248
remove unnecessary css
adamgayoso Jan 8, 2023
0c82d78
remove more scanpydoc
adamgayoso Jan 8, 2023
597347f
tutorials link
adamgayoso Jan 8, 2023
8829064
Merge branch 'master' into furo
adamgayoso Feb 6, 2023
214d21c
switch to sphinx book
adamgayoso Feb 13, 2023
c2cd226
pre commit'
adamgayoso Feb 13, 2023
2a3d166
update reqs
adamgayoso Feb 13, 2023
48a949e
logo only
adamgayoso Feb 13, 2023
3eddc41
deps
adamgayoso Feb 13, 2023
3b19c82
linkcode
adamgayoso Feb 13, 2023
5f76ae7
linkcode
adamgayoso Feb 13, 2023
ea37423
exclude patterns
adamgayoso Feb 13, 2023
c106472
sidebar levels
adamgayoso Feb 13, 2023
8d2252b
remove external tools
adamgayoso Feb 15, 2023
fc9624c
fix external
adamgayoso Feb 15, 2023
ff38251
Merge branch 'master' into furo
adamgayoso Feb 15, 2023
524df7f
Merge branch 'master' into furo
adamgayoso Feb 15, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitmodules
@@ -0,0 +1,3 @@
[submodule "docs/tutorials"]
path = docs/tutorials
url = https://github.com/scverse/scanpy-tutorials.git
4 changes: 4 additions & 0 deletions .readthedocs.yml
Expand Up @@ -11,3 +11,7 @@ python:
path: .
extra_requirements:
- doc
- leiden
submodules:
include:
- "docs/tutorials"
13 changes: 0 additions & 13 deletions docs/_key_contributors.rst

This file was deleted.

86 changes: 86 additions & 0 deletions docs/_static/css/override.css
@@ -0,0 +1,86 @@
/* for the sphinx design cards */
body {
--sd-color-shadow: dimgrey;
}

dt:target,
span.highlighted {
background-color: #f0f0f0;
}

dl.citation>dt {
float: left;
margin-right: 15px;
font-weight: bold;
}

/* Parameters normalize size and captialized, */
dl .field-list dt {
font-size: var(--font-size--normal) !important;
text-transform: none !important;
}

/* examples and headings in classes */
p.rubric {
font-size: var(--font-size--normal);
text-transform: none;
font-weight: 500;
}

/* so that api methods are small in sidebar */
li.toctree-l3 {
font-size: 81.25% !important;
}

li.toctree-l4 {
font-size: 75% !important;
}

/* for custom small role */
.small {
font-size: 40% !important
}

.smaller,
.pr {
font-size: 70% !important
}


/* nbsphinx specific */

.nbinput .prompt,
.nboutput .prompt {
display: none;
}

.nboutput .stderr {
display: none;
}

div.nblast.container {
padding-bottom: 10px !important;
padding-right: 0px;
padding-left: 0px;
}

div.nbinput.container {
padding-top: 10px !important;
padding-right: 0px;
padding-left: 0px;
}

div.nbinput.container div.input_area {
/* Code cell border that works in both dark and light mode */
border-color: rgba(127, 127, 127, .25) !important;
}


div.nbinput.container div.input_area div[class*="highlight"]>pre {
padding: 10px !important;
margin: 0;
}

p.topic-title {
margin-top: 0;
}
5 changes: 0 additions & 5 deletions docs/_templates/autosummary/base.rst

This file was deleted.

2 changes: 0 additions & 2 deletions docs/_templates/autosummary/class.rst
@@ -1,5 +1,3 @@
:github_url: {{ fullname | github_url }}
Zethson marked this conversation as resolved.
Show resolved Hide resolved

{{ fullname | escape | underline}}

.. currentmodule:: {{ module }}
Expand Down
29 changes: 21 additions & 8 deletions docs/tutorials.md → docs/_tutorials.md
Expand Up @@ -2,7 +2,7 @@

## Clustering

For getting started, we recommend Scanpy’s reimplementation {tutorial}`pbmc3k`
For getting started, we recommend Scanpy’s reimplementation {doc}`/tutorials/pbmc3k`
of Seurat’s [^cite_satija15] clustering tutorial for 3k PBMCs from 10x Genomics,
containing preprocessing, clustering and the identification of cell types via
known marker genes.
Expand All @@ -29,15 +29,15 @@ known marker genes.

## Visualization

This tutorial shows how to visually explore genes using scanpy. {tutorial}`plotting/core`
This tutorial shows how to visually explore genes using scanpy. {doc}`/tutorials/plotting/core`

```{image} _static/img/stacked_violin_dotplot_matrixplot.png
:width: 550px
```

## Trajectory inference

Get started with the following example for hematopoiesis for data of [^cite_paul15]: {tutorial}`paga-paul15`
Get started with the following example for hematopoiesis for data of [^cite_paul15]: {doc}`/tutorials/paga-paul15`

```{image} _static/img/tutorials/paga_paul15.png
:width: 450px
Expand All @@ -56,16 +56,16 @@ for two hematopoiesis datasets: [DPT example 1] [^cite_paul15] and [DPT example

## Integrating datasets

Map labels and embeddings of reference data to new data: {tutorial}`integrating-data-using-ingest`
Map labels and embeddings of reference data to new data: {doc}`/tutorials/integrating-data-using-ingest`

```{image} https://scanpy-tutorials.readthedocs.io/en/latest/_images/integrating-data-using-ingest_21_0.png
:width: 350px
```

## Spatial data

- Basic analysis of spatial data: {tutorial}`spatial/basic-analysis`
- Integrating spatial data with scRNA-seq using scanorama: {tutorial}`spatial/integration-scanorama`
- Basic analysis of spatial data: {doc}`/tutorials/spatial/basic-analysis`
- Integrating spatial data with scRNA-seq using scanorama: {doc}`/tutorials/spatial/integration-scanorama`

```{image} _static/img/spatial-basic-analysis.png
:width: 250px
Expand All @@ -77,7 +77,7 @@ Map labels and embeddings of reference data to new data: {tutorial}`integrating-

### Conversion: AnnData, SingleCellExperiment, and Seurat objects

```{image} https://github.com/scverse/scanpy-in-R/raw/master/logo.png
```{image} https://github.com/theislab/scanpy-in-R/raw/master/logo.png
:align: right
:width: 200px
```
Expand All @@ -96,7 +96,7 @@ See the [cell cycle] notebook.

### Normalization with Pearson Residuals

Normalization of scRNA-seq data with Pearson Residuals, from [^cite_lause21]: {tutorial}`tutorial_pearson_residuals`
Normalization of scRNA-seq data with Pearson Residuals, from [^cite_lause21]: {doc}`/tutorials/tutorial_pearson_residuals`

### Scaling Computations

Expand Down Expand Up @@ -138,3 +138,16 @@ See pseudotime-time inference on deep-learning based features for [cell cycle re
[scanpy in r]: https://theislab.github.io/scanpy-in-R/
[seurat to anndata]: https://github.com/LuckyMD/Code_snippets/blob/master/Seurat_to_anndata.ipynb
[toggleswitch]: https://nbviewer.jupyter.org/github/scverse/scanpy_usage/blob/master/170430_krumsiek11/toggleswitch.ipynb


```{toctree}
:hidden: true
:maxdepth: 1

tutorials/pbmc3k
tutorials/paga-paul15
tutorials/plotting/core
tutorials/integrating-data-using-ingest
tutorials/spatial/basic-analysis
tutorials/spatial/integration-scanorama
```