diff --git a/docs/source/conf.py b/docs/source/conf.py index a20c3c09..4e7c2c86 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -2,7 +2,6 @@ import sys import os import datetime -from sphinx_gallery.sorting import ExampleTitleSortKey # Sphinx needs to be able to import the package to use autodoc and get the version number sys.path.insert(0, os.path.abspath("../../pylops_mpi")) @@ -60,7 +59,7 @@ # Remove the "Download all examples" button from the top level gallery "download_all_examples": False, # Sort gallery example by file name instead of number of lines (default) - "within_subsection_order": ExampleTitleSortKey, + "within_subsection_order": "ExampleTitleSortKey", # directory where function granular galleries are stored "backreferences_dir": "api/generated/backreferences", # Modules for which function level galleries are created. diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 0b836ffd..d0aafe88 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -19,7 +19,7 @@ Additionally, to use the NCCL engine, the following additional dependencies are required: * `CuPy `_ -* `NCCL `_ +* `NCCL `__ We highly encourage using the `Anaconda Python distribution `_ or its standalone package manager `Conda `_. However, @@ -120,7 +120,7 @@ If you prefer a ``pip`` installation, we provide the following command Note that, differently from the ``conda`` command, the above **will not** create a virtual environment. Make sure you create and activate your environment previously. -Simlarly, if you want to enable `NCCL `_ but prefer using pip, +Similarly, if you want to enable `NCCL `_ but prefer using pip, you must first check the CUDA version of your system: .. code-block:: bash