diff --git a/doc/source/conf.py b/doc/source/conf.py index f24e16bdab..82c45fa9f0 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -45,9 +45,9 @@ "sphinx_rtd_theme", "sphinx.ext.napoleon", "sphinx.ext.mathjax", + "sphinx_copybutton", ] - # Document Python Code autoapi_type = "python" autoapi_dirs = ["../../heat/"] @@ -88,6 +88,9 @@ def setup(sphinx): napoleon_numpy_docstring = True napoleon_use_ivar = True +copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: " +copybutton_prompt_is_regexp = True + html_show_sourcelink = True # The suffix(es) of source filenames. diff --git a/doc/source/tutorial_30_minutes.rst b/doc/source/tutorial_30_minutes.rst index 9f91797939..82cfeacb2a 100644 --- a/doc/source/tutorial_30_minutes.rst +++ b/doc/source/tutorial_30_minutes.rst @@ -51,7 +51,7 @@ Output: DNDarray([0, 1, 2, 3, 4, 5, 6, 7, 8, 9], dtype=ht.int32, device=cpu:0, split=None) -The following snippet creates a column vector with :math:`5` element, each position filled with the value :math:`9` and the ``ht.int64`` data type. +The following snippet creates a column vector with :math:`5` elements, each position filled with the value :math:`9` and the ``ht.int64`` data type. .. code:: python diff --git a/doc/source/tutorials.rst b/doc/source/tutorials.rst index 71e8463148..6cc42143f2 100644 --- a/doc/source/tutorials.rst +++ b/doc/source/tutorials.rst @@ -38,7 +38,7 @@ Heat Tutorials
- Parallel Computing + Turn up the Heat - Parallel Computing

Speed up Heat even further with GPUs acceleration or distributed MPI computation.

Well-suited for beginners. @@ -57,7 +57,7 @@ Heat Tutorials
- Cluster Analysis + Keep the Heat - Cluster Analysis

Automatically identify clusters in your data by employing unsupervised clustering methods.

For intermediate analysts.