changed the formulas to match myst-parser (#132)

acostadon · web-flow · commit c18b46e02666 · 2025-06-26T17:52:18.000Z
Removed the explicit md and rst mention and let myst-parser handle it. This was also done to properly render formulas. Authors: - Don Acosta (https://github.com/acostadon) Approvers: - James Lamb (https://github.com/jameslamb) - Brad Rees (https://github.com/BradReesWork) URL: #132
diff --git a/conda/environments/all_cuda-129_arch-x86_64.yaml b/conda/environments/all_cuda-129_arch-x86_64.yaml
@@ -19,13 +19,13 @@ dependencies:
 - ipython
 - libcugraph==25.8.*,>=0.0.0a0
 - libcugraph_etl==25.8.*,>=0.0.0a0
+- myst-parser
 - nbsphinx
 - numpydoc
 - pre-commit
 - pydata-sphinx-theme
 - pylibcugraph==25.8.*,>=0.0.0a0
 - pylibwholegraph==25.8.*,>=0.0.0a0
-- recommonmark
 - sphinx-copybutton
 - sphinx-markdown-tables
 - sphinx>=8,<8.2.0
diff --git a/dependencies.yaml b/dependencies.yaml
@@ -68,10 +68,10 @@ dependencies:
           - doxygen
           - graphviz
           - ipython
+          - myst-parser
           - nbsphinx
           - numpydoc
           - pydata-sphinx-theme
-          - recommonmark
           - sphinx-copybutton
           - sphinx-markdown-tables
           # the ceiling on sphinx can be removed when https://github.com/spatialaudio/nbsphinx/issues/825 is resolved
diff --git a/docs/cugraph-docs/source/conf.py b/docs/cugraph-docs/source/conf.py
@@ -42,6 +42,7 @@
 # ones.
 extensions = [
     "breathe",
+    "myst_parser",
     "sphinx.ext.intersphinx",
     "sphinxcontrib.jsmath",
     "sphinx.ext.autodoc",
@@ -54,7 +55,6 @@
     "IPython.sphinxext.ipython_console_highlighting",
     "IPython.sphinxext.ipython_directive",
     "nbsphinx",
-    "recommonmark",
     "sphinx_copybutton",
 ]
 
@@ -69,8 +69,6 @@
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
-# source_suffix = ['.rst', '.md']
-source_suffix = {".rst": "restructuredtext", ".md": "markdown"}
 
 # The master toctree document.
 master_doc = 'index'
@@ -215,8 +213,6 @@ def setup(app):
     app.add_css_file("references.css")
 
 
-source_suffix = ['.rst', '.md']
-
 # The following is used by sphinx.ext.linkcode to provide links to github
 linkcode_resolve = make_linkcode_resolve(
     "https://github.com/rapidsai/cugraph/blob/{revision}/python/{path}#L{lineno}"
diff --git a/docs/cugraph-docs/source/graph_support/algorithms.md b/docs/cugraph-docs/source/graph_support/algorithms.md
@@ -1,6 +1,7 @@
 # List of Supported and Planned Algorithms
 
-## Supported Graph
+
+## Supported Graph Types
 
 | Type       | Description                                                 |
 | ---------- | ----------------------------------------------------------- |
@@ -22,7 +23,7 @@ Note: Multi-GPU, or MG, includes support for Multi-Node Multi-GPU (also called M
 
 | Category          | Notebooks                          | Scale               | Notes                                                           |
 | ----------------- | ---------------------------------- | ------------------- | --------------------------------------------------------------- |
-| [Centrality](./Centrality.html )        | [Centrality](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Centrality.ipynb)          |           |        |
+| [Centrality](./algorithms/Centrality.html)        | [Centrality](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Centrality.ipynb)          |           |        |
 |                   | [Katz](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Katz.ipynb)                                    | __Multi-GPU__  |                  |
 |                   | [Betweenness Centrality](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Betweenness.ipynb)           | __Multi-GPU__  | MG as of 23.06   |
 |                   | [Edge Betweenness Centrality](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Betweenness.ipynb)      | __Multi-GPU__  | MG as of 23.08   |
@@ -55,7 +56,7 @@ Note: Multi-GPU, or MG, includes support for Multi-Node Multi-GPU (also called M
 |                   | [Pagerank](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/link_analysis/Pagerank.ipynb)                | __Multi-GPU__ | [C++ README](./cpp_algorithms/centrality_cpp.html#Pagerank)                |
 |                   | [Personal Pagerank]()                  | __Multi-GPU__ | [C++ README](./cpp_algorithms/centrality_cpp.html#Personalized-Pagerank)   |
 |                   | [HITS](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/link_analysis/HITS.ipynb)        | __Multi-GPU__ |                |
-| [Link Prediction](./Similarity.html)   |                                    |                     |                                                                 |
+| [Link Prediction](./algorithms/Similarity.html)   |                                    |                     |                                                                 |
 |                   | [Jaccard Similarity](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/link_prediction/Jaccard-Similarity.ipynb)                 | __Multi-GPU__      | Directed graph only                         |
 |                   | [Weighted Jaccard Similarity](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/link_prediction/Jaccard-Similarity.ipynb)        | Single-GPU          |                                                                 |
 |                   | [Overlap Similarity](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/link_prediction/Overlap-Similarity.ipynb)                 | **Multi-GPU** |                                                   |
@@ -91,5 +92,4 @@ Copyright (c) 2019 - 2025, NVIDIA CORPORATION.
 
 Licensed under the Apache License, Version 2.0 (the "License");  you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 
-Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-___
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
diff --git a/docs/cugraph-docs/source/graph_support/algorithms/Centrality.md b/docs/cugraph-docs/source/graph_support/algorithms/Centrality.md
@@ -1,5 +1,16 @@
 
-# cuGraph Centrality Notebooks
+# cuGraph Centrality Algorithms
+
+```{toctree}
+:maxdepth: 1
+:hidden:
+
+
+degree_centrality
+betweenness_centrality
+eigenvector_centrality
+katz_centrality
+```
 
 <img src="../../_static/zachary_graph_centrality.png" width="35%"/>
 
@@ -15,10 +26,10 @@ But which vertices are most important? The answer depends on which measure/algor
 
 |Algorithm          |Notebooks Containing                                                     |Description                                                  |
 | --------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
-|[Degree Centrality](../degree_centrality.html)| [Centrality](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Centrality.ipynb), [Degree](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Degree.ipynb)                   |Measure based on counting direct connections for each vertex|
-|[Betweenness Centrality](../betweenness_centrality.html)| [Centrality](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Centrality.ipynb), [Betweenness](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Betweenness.ipynb)                    |Number of shortest paths through the vertex|
-|[Eigenvector Centrality](../eigenvector_centrality.html)|[Centrality](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Centrality.ipynb), [Eigenvector](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Eigenvector.ipynb)|Measure of connectivity to other important vertices (which also have high connectivity) often referred to as the influence measure of a vertex|
-|[Katz Centrality](../katz_centrality.html)|[Centrality](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Centrality.ipynb), [Katz](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Katz.ipynb)                                         |Similar to Eigenvector but has tweaks to measure more weakly connected graph  |
+|[Degree Centrality](degree_centrality.html)| [Centrality](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Centrality.ipynb), [Degree](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Degree.ipynb)                   |Measure based on counting direct connections for each vertex|
+|[Betweenness Centrality](betweenness_centrality.html)| [Centrality](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Centrality.ipynb), [Betweenness](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Betweenness.ipynb)                    |Number of shortest paths through the vertex|
+|[Eigenvector Centrality](eigenvector_centrality.html)|[Centrality](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Centrality.ipynb), [Eigenvector](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Eigenvector.ipynb)|Measure of connectivity to other important vertices (which also have high connectivity) often referred to as the influence measure of a vertex|
+|[Katz Centrality](katz_centrality.html)|[Centrality](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Centrality.ipynb), [Katz](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Katz.ipynb)                                         |Similar to Eigenvector but has tweaks to measure more weakly connected graph  |
 |Pagerank| [Pagerank](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/link_analysis/Pagerank.ipynb)                                         |Classified as both a link analysis and centrality measure by quantifying incoming links from central vertices.  |
 
 
diff --git a/docs/cugraph-docs/source/graph_support/algorithms/Similarity.md b/docs/cugraph-docs/source/graph_support/algorithms/Similarity.md
@@ -1,5 +1,15 @@
 
-# cuGraph Similarity Notebooks
+# cuGraph Similarity Algorithms
+
+```{toctree}
+:maxdepth: 1
+:hidden:
+
+jaccard_similarity
+overlap_similarity
+sorensen_coefficient
+```
+
 
 The RAPIDS cuGraph Similarity folder contain a collection of Jupyter Notebooks that demonstrate algorithms to quantify the similarity between pairs of vertices in the graph.
 Results of Similarity algorithms are often used to answer questions like:
@@ -15,9 +25,9 @@ Manipulation of the data before or after the graph analytic is not covered here.
 
 |Algorithm          |Notebooks Containing                                                     |Description                                                  |
 | --------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
-|[Jaccard Smiliarity](../jaccard_similarity.html)| [Jaccard Similarity](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/link_prediction/Jaccard-Similarity.ipynb)                 ||
-|[Overlap Similarity](../overlap_similarity.html)| [Overlap Similarity](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/link_prediction/Overlap-Similarity.ipynb)                    ||
-|[Sorensen](../sorensen_coefficient.html)|[Sorensen Similarity](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/link_prediction/Sorensen_coefficient.ipynb)||
+|[Jaccard Smiliarity](jaccard_similarity.html)| [Jaccard Similarity](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/link_prediction/Jaccard-Similarity.ipynb)                 ||
+|[Overlap Similarity](overlap_similarity.html)| [Overlap Similarity](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/link_prediction/Overlap-Similarity.ipynb)                    ||
+|[Sorensen](sorensen_coefficient.html)|[Sorensen Similarity](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/link_prediction/Sorensen_coefficient.ipynb)||
 |Personal Pagerank|[Pagerank](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/link_analysis/Pagerank.ipynb)                 ||
 
 
@@ -28,4 +38,3 @@ Copyright (c) 2019 - 2025, NVIDIA CORPORATION.
 Licensed under the Apache License, Version 2.0 (the "License");  you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-___
diff --git a/docs/cugraph-docs/source/graph_support/algorithms/betweenness_centrality.md b/docs/cugraph-docs/source/graph_support/algorithms/betweenness_centrality.md
@@ -7,11 +7,11 @@ See [Betweenness on Wikipedia](https://en.wikipedia.org/wiki/Betweenness_central
 Betweenness centrality of a node 𝑣 is the sum of the fraction of all-pairs shortest paths that pass through 𝑣
 
 
-<div class="math">
-\[
+$$
 c_B(v) =\sum_{s,t \in V} \frac{\sigma(s, t|v)}{\sigma(s, t)}
-\]
-</div>
+$$
+
+
 
 ## When to use BC
 Betweenness centrality is often used to answer questions like:
@@ -43,4 +43,3 @@ Copyright (c) 2023-2025, NVIDIA CORPORATION.
 Licensed under the Apache License, Version 2.0 (the "License");  you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-___
diff --git a/docs/cugraph-docs/source/graph_support/algorithms/cpp_algorithms/centrality_cpp.md b/docs/cugraph-docs/source/graph_support/algorithms/cpp_algorithms/centrality_cpp.md
@@ -84,5 +84,4 @@ Copyright (c) 2019 - 2025, NVIDIA CORPORATION.
 
 Licensed under the Apache License, Version 2.0 (the "License");  you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 
-Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-___
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
diff --git a/docs/cugraph-docs/source/graph_support/algorithms/degree_centrality.md b/docs/cugraph-docs/source/graph_support/algorithms/degree_centrality.md
@@ -6,11 +6,9 @@ See [Degree Centrality on Wikipedia](https://en.wikipedia.org/wiki/Degree_centra
 Degree centrality of a vertex 𝑣 is the sum of the edges incident on that node.
 
 
-<div class="math">
-\[
+$$
 C_d(v) = \frac{{\text{degree of vertex } \ v}}{{\text{number of vertices in graph} - 1}}
-\]
-</div>
+$$
 
 ## When to use Degree Centrality
 * When you need a really quick identifcation of important nodes on very simply structured data.
@@ -34,4 +32,3 @@ Copyright (c) 2023-2025, NVIDIA CORPORATION.
 Licensed under the Apache License, Version 2.0 (the "License");  you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-___
diff --git a/docs/cugraph-docs/source/graph_support/algorithms/eigenvector_centrality.md b/docs/cugraph-docs/source/graph_support/algorithms/eigenvector_centrality.md
@@ -9,11 +9,9 @@ See [Eigenvector Centrality on Wikipedia](https://en.wikipedia.org/wiki/Eigenvec
 The eigenvector centrality for node i is the
 i-th element of the vector x defined by the eigenvector equation.
 
-<div class="math">
-\[
-x_v = \frac{1}{\lambda}{\sum_{t \in M(v)}}x_t = \frac{1}{\lambda}{\sum_{t \in V}{a_v,x_t}
-\]
-</div>
+$$
+x_v = \frac{1}{\lambda}{\sum_{t \in M(v)}}x_t = \frac{1}{\lambda}{\sum_{t \in V}{a_v,x_t}}
+$$
 
 
 
@@ -42,5 +40,4 @@ Copyright (c) 2023-2025, NVIDIA CORPORATION.
 
 Licensed under the Apache License, Version 2.0 (the "License");  you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 
-Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-___
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
diff --git a/docs/cugraph-docs/source/graph_support/algorithms/jaccard_similarity.md b/docs/cugraph-docs/source/graph_support/algorithms/jaccard_similarity.md
@@ -5,11 +5,9 @@ The Jaccard similarity between two sets is defined as the ratio of the volume of
 The Jaccard Similarity can then be defined as
 
 
-<div class="math">
-\[
+$$
 S_j = \frac{|A \cap B|}{|A \cup B|}
-\]
-</div>
+$$
 
 In graphs, the sets refer to the set of connected nodes or neighborhood of nodes A and B.
 
@@ -35,5 +33,4 @@ Copyright (c) 2023-2025, NVIDIA CORPORATION.
 
 Licensed under the Apache License, Version 2.0 (the "License");  you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 
-Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-___
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
diff --git a/docs/cugraph-docs/source/graph_support/algorithms/katz_centrality.md b/docs/cugraph-docs/source/graph_support/algorithms/katz_centrality.md
@@ -2,11 +2,9 @@
 
 Katz centrality is a measure of the relative importance of a vertex within the graph based on measuring the influence across the total number of walks between vertex pairs. Katz is similar to Eigenvector centrality. The main difference is that Katz also takes into account indirect relationships. The Katz calculation includes a user-controlled attenuation variable that controls the weight of indirect relationships. Otherwise it shares many of the advantages and disadvantages of Eigenvector centrality.
 
-<div class="math">
-\[
+$$
 C_{katz}(i) = \sum_{k=1}^{\infty} \sum_{j=1}^{n} \alpha ^k(A^k)_{ji}
-\]
-</div>
+$$
 
 See [Katz on Wikipedia](https://en.wikipedia.org/wiki/Katz_centrality) for more details on the algorithm.
 
@@ -29,4 +27,3 @@ Copyright (c) 2023-2025, NVIDIA CORPORATION.
 Licensed under the Apache License, Version 2.0 (the "License");  you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-___
diff --git a/docs/cugraph-docs/source/graph_support/algorithms/overlap_similarity.md b/docs/cugraph-docs/source/graph_support/algorithms/overlap_similarity.md
diff --git a/docs/cugraph-docs/source/graph_support/algorithms/sorensen_coefficient.md b/docs/cugraph-docs/source/graph_support/algorithms/sorensen_coefficient.md
diff --git a/docs/cugraph-docs/source/graph_support/graph_algorithms.rst b/docs/cugraph-docs/source/graph_support/graph_algorithms.rst
diff --git a/docs/cugraph-docs/source/graph_support/index.rst b/docs/cugraph-docs/source/graph_support/index.rst
diff --git a/docs/cugraph-docs/source/nx_cugraph/how-it-works.md b/docs/cugraph-docs/source/nx_cugraph/how-it-works.md
diff --git a/docs/cugraph-docs/source/tutorials/cugraph_notebooks.md b/docs/cugraph-docs/source/tutorials/cugraph_notebooks.md
