Skip to content

Commit 84749c2

Browse files
authored
[python] Reduce warnings during doc builds + fix broken links (#1162)
* Add autosummary to gitignore * Move unused docs, and fix line lengths * Fix some links * Remove soma.rst + setup.rst as @ebezzi says they are outdated
1 parent 36d98e8 commit 84749c2

10 files changed

+11
-90
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ instance/
7373

7474
# Sphinx documentation
7575
docs/_build/
76+
_autosummary
7677

7778
# PyBuilder
7879
target/

docs/README.md dev-docs/README.md

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/articles.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
What's new?
2-
==========
2+
===========
33

44
2023
55
----------

docs/examples.rst

+9-10
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
Python tutorials
2-
==========
2+
================
33

44

55
Exporting data
6-
----------
6+
--------------
77

88
Learn how to stream the single-cell data and metadata from Census into your machine.
99

@@ -16,7 +16,7 @@ Learn how to stream the single-cell data and metadata from Census into your mach
1616
notebooks/api_demo/census_gget_demo.ipynb
1717

1818
[NEW! 🚀] Using integrated embeddings and models
19-
----------
19+
------------------------------------------------
2020

2121
Tutorials that show you how to retrieve pre-calculated Census embeddings and use their associated models for your workflows.
2222

@@ -44,23 +44,22 @@ Exploring human biology with Census embeddings.
4444
notebooks/analysis_demo/comp_bio_embedding_exploration.ipynb
4545

4646
Understanding Census data
47-
----------
47+
--------------------------
4848

4949
Gain a better understanding on the nature of the Census data and how it's organized.
5050

5151
.. toctree::
5252
:maxdepth: 1
5353

54-
notebooks/analysis_demo/census_duplicated_cells.ipynb
54+
notebooks/api_demo/census_duplicated_cells.ipynb
5555
notebooks/analysis_demo/comp_bio_census_info.ipynb
56-
notebooks/analysis_demo/census_summary_cell_counts.ipynb
5756
notebooks/analysis_demo/comp_bio_explore_and_load_lung_data.ipynb
5857
notebooks/api_demo/census_datasets.ipynb
5958
notebooks/api_demo/census_dataset_presence.ipynb
6059
notebooks/api_demo/census_summary_cell_counts.ipynb
6160

6261
Analyzing Census data
63-
----------
62+
---------------------
6463

6564
A few examples of relevant analysis pipelines with Census data.
6665

@@ -72,7 +71,7 @@ A few examples of relevant analysis pipelines with Census data.
7271
notebooks/analysis_demo/comp_bio_normalizing_full_gene_sequencing.ipynb
7372

7473
Scalable computing
75-
----------
74+
------------------
7675

7776
Demonstrations of memory-efficient compute workflows that leverage the streaming capabilities of Census.
7877

@@ -81,10 +80,10 @@ Demonstrations of memory-efficient compute workflows that leverage the streaming
8180

8281
notebooks/experimental/highly_variable_genes.ipynb
8382
notebooks/experimental/mean_variance.ipynb
84-
notebooks/analysis_demo/census_compute_over_X.ipynb
83+
notebooks/api_demo/census_compute_over_X.ipynb
8584

8685
Scalable machine learning
87-
----------
86+
-------------------------
8887

8988
Learn about features to do data modeling directly from Census into machine learning toolkits.
9089

docs/setup.rst

-59
This file was deleted.

docs/soma.rst

-20
This file was deleted.

0 commit comments

Comments
 (0)