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

Update readthedocs #26

Merged
merged 3 commits into from
Aug 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions docs/source/Introduction.rst

This file was deleted.

2 changes: 0 additions & 2 deletions docs/source/Tutorials.rst

This file was deleted.

29 changes: 27 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,26 +24,48 @@
# The full version, including alpha/beta/rc tags
release = "v0.1.0"

# -- Retrieve notebooks -------------------------------

from urllib.request import urlretrieve # noqa: E402

notebooks_url = "https://github.com/pinellolab/STREAM2_tutorials/raw/main/tutorial_notebooks/" # noqa
notebooks_v1_0 = [
"complex_structure.ipynb",
"supervision_ordinal.ipynb",
"supervision_categorical.ipynb",
"multiomics.ipynb",
"stream_plots.ipynb",
]

for nb in notebooks_v1_0:
try:
urlretrieve(notebooks_url + nb, nb)
except Exception:
pass

# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"sphinx.ext.intersphinx",
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
'sphinx.ext.napoleon',
"sphinx.ext.intersphinx",
"sphinx.ext.mathjax",
"sphinx.ext.viewcode",
"nbsphinx",
]
autosummary_generate = True

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
exclude_patterns = ['_build']


# -- Options for HTML output -------------------------------------------------
Expand All @@ -53,6 +75,9 @@
#
html_theme = "sphinx_rtd_theme"

github_repo = 'stream2'
github_nb_repo = 'stream2_tutorials'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
Expand Down
19 changes: 11 additions & 8 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,17 @@ Contents
:maxdepth: 2
:caption: Contents:

Introduction
About STREAM2
Installation
Tutorials
API


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. toctree::
:maxdepth: 1
:caption: Tutorials

complex_structure
supervision_ordinal
supervision_categorical
multiomics
stream_plots
833 changes: 0 additions & 833 deletions docs/tutorial/stream_plots.ipynb

This file was deleted.

Loading