From ee46cf404f78d8f864629947856bf089643ce644 Mon Sep 17 00:00:00 2001 From: Charles Blackmon-Luca <20627856+charlesbluca@users.noreply.github.com> Date: Tue, 18 Jul 2023 12:49:42 -0700 Subject: [PATCH] Remove RTD configuration / references --- .readthedocs.yml | 7 -- README.md | 6 +- dask_cuda/cuda_worker.py | 4 +- dask_cuda/local_cuda_cluster.py | 4 +- rtd/Makefile | 19 --- rtd/conf.py | 211 -------------------------------- rtd/index.rst | 1 - rtd/templates/redirect.html | 11 -- 8 files changed, 6 insertions(+), 257 deletions(-) delete mode 100644 .readthedocs.yml delete mode 100644 rtd/Makefile delete mode 100644 rtd/conf.py delete mode 100644 rtd/index.rst delete mode 100644 rtd/templates/redirect.html diff --git a/.readthedocs.yml b/.readthedocs.yml deleted file mode 100644 index fd5ccf68..00000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,7 +0,0 @@ -version: 2 - -sphinx: - configuration: rtd/conf.py - -formats: - - htmlzip diff --git a/README.md b/README.md index da343f7c..7d42cef7 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -[![RTD](https://readthedocs.org/projects/dask-cuda/badge/?version=latest)](https://dask-cuda.readthedocs.io/en/latest/?badge=latest) - Dask CUDA ========= @@ -20,7 +18,7 @@ cluster = LocalCUDACluster() client = Client(cluster) ``` -Documentation is available [here](https://dask-cuda.readthedocs.io/). +Documentation is available [here](https://docs.rapids.ai/api/dask-cuda/nightly/). What this is not ---------------- @@ -32,4 +30,4 @@ systems. Parallelizing GPU libraries like [RAPIDS](https://rapids.ai) and [CuPy](https://cupy.chainer.org) with Dask is an ongoing effort. You may wish to read about this effort at [blog.dask.org](https://blog.dask.org) for more information. Additional information about Dask-CUDA can also be found in the -[docs]( https://dask-cuda.readthedocs.io ). +[docs](https://docs.rapids.ai/api/dask-cuda/nightly/). diff --git a/dask_cuda/cuda_worker.py b/dask_cuda/cuda_worker.py index f12ad678..9dc2d56c 100644 --- a/dask_cuda/cuda_worker.py +++ b/dask_cuda/cuda_worker.py @@ -144,8 +144,8 @@ def del_pid_file(): warnings.warn( "When using NVLink we recommend setting a " "`rmm_pool_size`. Please see: " - "https://dask-cuda.readthedocs.io/en/latest/ucx.html" - "#important-notes for more details" + "https://docs.rapids.ai/api/dask-cuda/nightly/ucx/ " + "for more details" ) if enable_nvlink and rmm_managed_memory: diff --git a/dask_cuda/local_cuda_cluster.py b/dask_cuda/local_cuda_cluster.py index ee08678b..32448433 100644 --- a/dask_cuda/local_cuda_cluster.py +++ b/dask_cuda/local_cuda_cluster.py @@ -276,8 +276,8 @@ def __init__( warnings.warn( "When using NVLink we recommend setting a " "`rmm_pool_size`. Please see: " - "https://dask-cuda.readthedocs.io/en/latest/ucx.html" - "#important-notes for more details" + "https://docs.rapids.ai/api/dask-cuda/nightly/ucx/ " + "for more details" ) self.rmm_log_directory = rmm_log_directory diff --git a/rtd/Makefile b/rtd/Makefile deleted file mode 100644 index ba501f6f..00000000 --- a/rtd/Makefile +++ /dev/null @@ -1,19 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -SOURCEDIR = source -BUILDDIR = build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/rtd/conf.py b/rtd/conf.py deleted file mode 100644 index fe71b19e..00000000 --- a/rtd/conf.py +++ /dev/null @@ -1,211 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Configuration file for the Sphinx documentation builder. -# -# This file does only contain a selection of the most common options. For a -# full list see the documentation: -# http://www.sphinx-doc.org/en/master/config - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -import datetime -import os -import shutil - -# -- Project information ----------------------------------------------------- - -project = "dask-cuda" -copyright = "2020-%s, NVIDIA" % datetime.datetime.now().year -author = "NVIDIA" - -# The full version, including alpha/beta/rc tags. -release = "21.06" - -# The short X.Y version. -version = "21.06" - - -# -- General configuration --------------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. -# -# needs_sphinx = '1.0' - -# 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.autodoc", -# "sphinx.ext.mathjax", -# "sphinx.ext.viewcode", -# "sphinx.ext.githubpages", -# "sphinx.ext.autosummary", -# "sphinx.ext.intersphinx", -# "sphinx.ext.extlinks", -# "numpydoc", -# "sphinx_click", -# "sphinx_rtd_theme", -# ] - -# numpydoc_show_class_members = False - -# Add any paths that contain templates here, relative to this directory. -# templates_path = ["_templates"] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# -# source_suffix = ['.rst', '.md'] -source_suffix = ".rst" - -# The master toctree document. -master_doc = "index" - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# 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 = [] - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = None - - -# -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -# html_theme = "sphinx_rtd_theme" - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# -# html_theme_options = {} - -# 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". -# html_static_path = ["_static"] - -# Custom sidebar templates, must be a dictionary that maps document names -# to template names. -# -# The default sidebars (for documents that don't match any pattern) are -# defined by theme itself. Builtin themes are using these templates by -# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', -# 'searchbox.html']``. -# -# html_sidebars = {} - - -# -- Options for HTMLHelp output --------------------------------------------- - -# Output file base name for HTML help builder. -htmlhelp_basename = "dask-cudadoc" - - -# -- Options for LaTeX output ------------------------------------------------ - -# latex_elements = { -# # The paper size ('letterpaper' or 'a4paper'). -# # -# # 'papersize': 'letterpaper', -# # The font size ('10pt', '11pt' or '12pt'). -# # -# # 'pointsize': '10pt', -# # Additional stuff for the LaTeX preamble. -# # -# # 'preamble': '', -# # Latex figure (float) alignment -# # -# # 'figure_align': 'htbp', -# } - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -# latex_documents = [ -# (master_doc, "dask-cuda.tex", "dask-cuda Documentation", "NVIDIA", "manual") -# ] - - -# -- Options for manual page output ------------------------------------------ - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -# man_pages = [(master_doc, "dask-cuda", "dask-cuda Documentation", [author], 1)] - - -# -- Options for Texinfo output ---------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -# texinfo_documents = [ -# ( -# master_doc, -# "dask-cuda", -# "dask-cuda Documentation", -# author, -# "dask-cuda", -# "One line description of project.", -# "Miscellaneous", -# ) -# ] - - -# -- Options for Epub output ------------------------------------------------- - -# Bibliographic Dublin Core info. -# epub_title = project - -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -# -# epub_identifier = '' - -# A unique identification for the text. -# -# epub_uid = '' - -# A list of files that should not be packed into the epub file. -# epub_exclude_files = ["search.html"] - - -# -- Extension configuration ------------------------------------------------- - -# lifted from dask-ml -templates_path = ["templates"] -pages = [ - "index", -] -html_additional_pages = {page: "redirect.html" for page in pages} -html_context = { - "redirects": { - page: f"https://docs.rapids.ai/api/dask-cuda/nightly/{page}" for page in pages - } -} - - -def add_404(app, docname): - if app.builder.format == "html": - pth_index = os.path.join(app.outdir, "index.html") - pth_404 = os.path.join(app.outdir, "404.html") - if os.path.exists(pth_index): - shutil.copyfile(pth_index, pth_404) - - -def setup(app): - app.connect("build-finished", add_404) diff --git a/rtd/index.rst b/rtd/index.rst deleted file mode 100644 index e4d44710..00000000 --- a/rtd/index.rst +++ /dev/null @@ -1 +0,0 @@ -This page has moved! diff --git a/rtd/templates/redirect.html b/rtd/templates/redirect.html deleted file mode 100644 index 6c59fe2d..00000000 --- a/rtd/templates/redirect.html +++ /dev/null @@ -1,11 +0,0 @@ -{% set redirect = redirects[pagename.split("/")[-1]] %} - - - - dask-cuda docs - - -

The dask-cuda documentation has moved!

-

You will now be redirected to our new page.

- -