Skip to content

Commit 64487d8

Browse files
ShaokunAnShaokunAn
committed
add per-method API pages using automethod stubs
1 parent 6a8cf50 commit 64487d8

38 files changed

Lines changed: 268 additions & 12 deletions

File tree

‎docs/api/spatial_query.md‎

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,36 @@
11
# spatial\_query
22

33
```{eval-rst}
4-
.. autoclass:: SpatialQuery.spatial_query
5-
:members:
6-
:undoc-members: False
7-
:private-members: False
8-
:special-members: __init__
4+
.. currentmodule:: SpatialQuery
5+
6+
.. autoclass:: spatial_query
97
:show-inheritance:
10-
:member-order: bysource
8+
:no-members:
9+
```
10+
11+
## Methods
12+
13+
```{toctree}
14+
:maxdepth: 1
15+
16+
../generated/SpatialQuery.spatial_query.__init__
17+
../generated/SpatialQuery.spatial_query.find_fp_knn
18+
../generated/SpatialQuery.spatial_query.find_fp_dist
19+
../generated/SpatialQuery.spatial_query.motif_enrichment_knn
20+
../generated/SpatialQuery.spatial_query.motif_enrichment_dist
21+
../generated/SpatialQuery.spatial_query.find_patterns_grid
22+
../generated/SpatialQuery.spatial_query.find_patterns_rand
23+
../generated/SpatialQuery.spatial_query.de_genes
24+
../generated/SpatialQuery.spatial_query.compute_gene_gene_correlation
25+
../generated/SpatialQuery.spatial_query.compute_gene_gene_correlation_by_type
26+
../generated/SpatialQuery.spatial_query.test_score_difference
27+
../generated/SpatialQuery.spatial_query.plot_fov
28+
../generated/SpatialQuery.spatial_query.plot_motif_grid
29+
../generated/SpatialQuery.spatial_query.plot_motif_rand
30+
../generated/SpatialQuery.spatial_query.plot_motif_celltype
31+
../generated/SpatialQuery.spatial_query.plot_all_center_motif
32+
../generated/SpatialQuery.spatial_query.plot_fp_heatmap
33+
../generated/SpatialQuery.spatial_query.plot_motif_enrichment_heatmap
34+
../generated/SpatialQuery.spatial_query.plot_gene_pair_heatmap
35+
../generated/SpatialQuery.spatial_query.plot_gene_pair_spatial
1136
```

‎docs/api/spatial_query_multi.md‎

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,31 @@
11
# spatial\_query\_multi
22

33
```{eval-rst}
4-
.. autoclass:: SpatialQuery.spatial_query_multi
5-
:members:
6-
:undoc-members: False
7-
:private-members: False
8-
:special-members: __init__
4+
.. currentmodule:: SpatialQuery
5+
6+
.. autoclass:: spatial_query_multi
97
:show-inheritance:
10-
:member-order: bysource
8+
:no-members:
9+
```
10+
11+
## Methods
12+
13+
```{toctree}
14+
:maxdepth: 1
15+
16+
../generated/SpatialQuery.spatial_query_multi.__init__
17+
../generated/SpatialQuery.spatial_query_multi.find_fp_knn
18+
../generated/SpatialQuery.spatial_query_multi.find_fp_dist
19+
../generated/SpatialQuery.spatial_query_multi.find_fp_knn_fov
20+
../generated/SpatialQuery.spatial_query_multi.find_fp_dist_fov
21+
../generated/SpatialQuery.spatial_query_multi.motif_enrichment_knn
22+
../generated/SpatialQuery.spatial_query_multi.motif_enrichment_dist
23+
../generated/SpatialQuery.spatial_query_multi.differential_analysis_knn
24+
../generated/SpatialQuery.spatial_query_multi.differential_analysis_dist
25+
../generated/SpatialQuery.spatial_query_multi.de_genes
26+
../generated/SpatialQuery.spatial_query_multi.compute_gene_gene_correlation
27+
../generated/SpatialQuery.spatial_query_multi.compute_gene_gene_correlation_by_type
28+
../generated/SpatialQuery.spatial_query_multi.test_score_difference
29+
../generated/SpatialQuery.spatial_query_multi.plot_cell_type_distribution
30+
../generated/SpatialQuery.spatial_query_multi.plot_cell_type_distribution_fov
1131
```

‎docs/conf.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
autodoc_mock_imports = ['SpatialQueryEliasFanoDB']
2323

2424
autosummary_generate = True
25+
autosummary_generate_overwrite = True
2526
napoleon_numpy_docstring = True
2627
napoleon_google_docstring = False
2728
autodoc_typehints = 'description'

‎docs/generated/SpatialQuery.spatial_query.__init__.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
SpatialQuery.spatial_query.__init__
2+
===================================
3+
4+
.. currentmodule:: SpatialQuery
5+
6+
.. automethod:: spatial_query.__init__

‎docs/generated/SpatialQuery.spatial_query.compute_gene_gene_correlation.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
SpatialQuery.spatial_query.compute_gene_gene_correlation
2+
========================================================
3+
4+
.. currentmodule:: SpatialQuery
5+
6+
.. automethod:: spatial_query.compute_gene_gene_correlation

‎docs/generated/SpatialQuery.spatial_query.compute_gene_gene_correlation_by_type.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
SpatialQuery.spatial_query.compute_gene_gene_correlation_by_type
2+
================================================================
3+
4+
.. currentmodule:: SpatialQuery
5+
6+
.. automethod:: spatial_query.compute_gene_gene_correlation_by_type

‎docs/generated/SpatialQuery.spatial_query.de_genes.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
SpatialQuery.spatial_query.de_genes
2+
===================================
3+
4+
.. currentmodule:: SpatialQuery
5+
6+
.. automethod:: spatial_query.de_genes

‎docs/generated/SpatialQuery.spatial_query.find_fp_dist.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
SpatialQuery.spatial_query.find_fp_dist
2+
=======================================
3+
4+
.. currentmodule:: SpatialQuery
5+
6+
.. automethod:: spatial_query.find_fp_dist

‎docs/generated/SpatialQuery.spatial_query.find_fp_knn.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
SpatialQuery.spatial_query.find_fp_knn
2+
======================================
3+
4+
.. currentmodule:: SpatialQuery
5+
6+
.. automethod:: spatial_query.find_fp_knn

‎docs/generated/SpatialQuery.spatial_query.find_patterns_grid.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
SpatialQuery.spatial_query.find_patterns_grid
2+
=============================================
3+
4+
.. currentmodule:: SpatialQuery
5+
6+
.. automethod:: spatial_query.find_patterns_grid

0 commit comments

Comments
 (0)