Skip to content

Fix sphinx warnings #143

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 21, 2025
Merged

Fix sphinx warnings #143

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 1 addition & 2 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"))
Expand Down Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Additionally, to use the NCCL engine, the following additional
dependencies are required:

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

We highly encourage using the `Anaconda Python distribution <https://www.anaconda.com/download>`_
or its standalone package manager `Conda <https://docs.conda.io/en/latest/index.html>`_. However,
Expand Down Expand Up @@ -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 <https://developer.nvidia.com/nccl>`_ but prefer using pip,
Similarly, if you want to enable `NCCL <https://developer.nvidia.com/nccl>`_ but prefer using pip,
you must first check the CUDA version of your system:

.. code-block:: bash
Expand Down