Skip to content

Commit 750d41d

Browse files
authored
Merge pull request #143 from PyLops/fix-sphinx-warnings
Fix sphinx warnings
2 parents 18e31ab + c375e80 commit 750d41d

File tree

2 files changed

+3
-4
lines changed

2 files changed

+3
-4
lines changed

docs/source/conf.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
import sys
33
import os
44
import datetime
5-
from sphinx_gallery.sorting import ExampleTitleSortKey
65

76
# Sphinx needs to be able to import the package to use autodoc and get the version number
87
sys.path.insert(0, os.path.abspath("../../pylops_mpi"))
@@ -60,7 +59,7 @@
6059
# Remove the "Download all examples" button from the top level gallery
6160
"download_all_examples": False,
6261
# Sort gallery example by file name instead of number of lines (default)
63-
"within_subsection_order": ExampleTitleSortKey,
62+
"within_subsection_order": "ExampleTitleSortKey",
6463
# directory where function granular galleries are stored
6564
"backreferences_dir": "api/generated/backreferences",
6665
# Modules for which function level galleries are created.

docs/source/installation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Additionally, to use the NCCL engine, the following additional
1919
dependencies are required:
2020

2121
* `CuPy <https://cupy.dev/>`_
22-
* `NCCL <https://docs.cupy.dev/en/stable/install.html#additional-cuda-libraries>`_
22+
* `NCCL <https://docs.cupy.dev/en/stable/install.html#additional-cuda-libraries>`__
2323

2424
We highly encourage using the `Anaconda Python distribution <https://www.anaconda.com/download>`_
2525
or its standalone package manager `Conda <https://docs.conda.io/en/latest/index.html>`_. However,
@@ -120,7 +120,7 @@ If you prefer a ``pip`` installation, we provide the following command
120120
Note that, differently from the ``conda`` command, the above **will not** create a virtual environment.
121121
Make sure you create and activate your environment previously.
122122

123-
Simlarly, if you want to enable `NCCL <https://developer.nvidia.com/nccl>`_ but prefer using pip,
123+
Similarly, if you want to enable `NCCL <https://developer.nvidia.com/nccl>`_ but prefer using pip,
124124
you must first check the CUDA version of your system:
125125

126126
.. code-block:: bash

0 commit comments

Comments
 (0)