Skip to content

Commit 68a4022

Browse files
authored
Merge pull request #39 from broadinstitute/ziq
Ziq
2 parents a2ca658 + 2ff516e commit 68a4022

File tree

71 files changed

+4918
-2069
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+4918
-2069
lines changed

docs/Makefile

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
13+
if "%1" == "" goto help
14+
15+
%SPHINXBUILD% >NUL 2>NUL
16+
if errorlevel 9009 (
17+
echo.
18+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19+
echo.installed, then set the SPHINXBUILD environment variable to point
20+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
21+
echo.may add the Sphinx directory to PATH.
22+
echo.
23+
echo.If you don't have Sphinx installed, grab it from
24+
echo.http://sphinx-doc.org/
25+
exit /b 1
26+
)
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

docs/requirements.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
sphinx==4.0.2
2+
nbsphinx==0.8.6
3+
nbsphinx-link==1.3.0
4+
sphinx-rtd-theme
5+
torch
6+
pandas==1.1.0
7+
numpy==1.19.1
8+
scipy==1.5.2
9+
seaborn==0.11.1
10+
scanpy>=1.6.0
11+
scikit-learn
12+
tqdm
13+
sphinx-gallery==0.9.0

docs/source/_contributors.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. sidebar:: Contributors
2+
3+
* `Tommaso Biancalani`_: author of method, PyPI maintainer :mod:`Contact: [email protected]`
4+
* Gabriele Scalia: author of method :mod:`Contact: [email protected]`
5+
* Ziqing Lu: PyPI maintainer :mod:`Contact: [email protected]`
6+
* Shreya Gaddam: PyPI maintainer :mod:`Contact: [email protected]`
7+
* Anna Hupalowska: Artwork :mod:`Contact: [email protected]`
8+
9+
.. _Tommaso Biancalani: https://twitter.com/tbyanc?lang=en

docs/source/_static/css/custom.css

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
.small {
2+
font-size: 55%;
3+
}
4+
5+
/*size of the page*/
6+
7+
.wy-nav-content {
8+
max-width: 1500px !important;
9+
}
10+
11+
div.version {
12+
color: #4d79ff!important;
13+
}
14+
15+
/*side-bar background color*/
16+
.wy-nav-side {
17+
background: #4d79ff!important;
18+
}
19+
20+
/*logo area*/
21+
.wy-side-nav-search {
22+
background-color: #ffffff!important;
23+
}
24+
25+
.wy-side-nav-search {
26+
border: 4px solid #4d79ff;
27+
}
28+
29+
.wy-side-nav-search input[type="text"] {
30+
border-radius: 6px!important;
31+
}
32+
33+
.wy-nav-content{
34+
max-width: 950px;
35+
}
36+
37+
38+
/* color for hovering over the topics */
39+
.wy-menu-vertical a:hover {
40+
background-color: #00e6e6
41+
}
42+
43+
/*color for text when hovering*/
44+
.wy-menu-vertical a:hover {
45+
color: #0000ff
46+
}
47+
48+
/* color for hovering over the selected topic */
49+
.wy-menu-vertical li.current a:hover {
50+
background: #00e6e6;
51+
}
52+
53+
.wy-menu > .caption > span.caption-text {
54+
color: #ffffff;
55+
}
56+
37.4 KB
Loading
7.51 KB
Loading
781 KB
Loading
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{{ fullname | escape | underline}}
2+
3+
.. currentmodule:: {{ module }}
4+
5+
.. auto{{ objtype }}:: {{ objname }}
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
{{ fullname | escape | underline}}
2+
3+
.. currentmodule:: {{ module }}
4+
5+
.. autoclass:: {{ objname }}
6+
7+
{% block methods %}
8+
{% block attributes %}
9+
{% if attributes %}
10+
.. autosummary::
11+
:toctree:
12+
{% for item in all_attributes %}
13+
{%- if not item.startswith('_') %}
14+
{{ name }}.{{ item }}
15+
{%- endif -%}
16+
{%- endfor %}
17+
{% endif %}
18+
{% endblock %}
19+
20+
{% if methods %}
21+
.. autosummary::
22+
:toctree:
23+
{% for item in all_methods %}
24+
{%- if not item.startswith('_') or item in ['__call__'] %}
25+
{{ name }}.{{ item }}
26+
{%- endif -%}
27+
{%- endfor %}
28+
{% endif %}
29+
{% endblock %}

0 commit comments

Comments
 (0)