Skip to content

Commit

Permalink
Update things to use nx-cugraph instead of cugraph
Browse files Browse the repository at this point in the history
  • Loading branch information
nv-rliu committed Oct 30, 2024
1 parent eb6a6df commit ef3b496
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions docs/nx-cugraph/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,11 @@
import os
import sys

import cugraph
from github_link import make_linkcode_resolve
from packaging.version import Version

import nx_cugraph

# If extensions (or modules to document with autodoc) are in another
# directory, add these directories to sys.path here. If the directory
# is relative to the documentation root, use os.path.abspath to make it
Expand Down Expand Up @@ -71,21 +72,21 @@
master_doc = "index"

# General information about the project.
project = "cugraph"
project = "nx-cugraph"
copyright = "2019-2024, NVIDIA Corporation"
author = "NVIDIA Corporation"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
CUGRAPH_VERSION = Version(cugraph.__version__)
NXCG_VERSION = Version(nx_cugraph.__version__)
# The short X.Y version.
version = f"{CUGRAPH_VERSION.major:02}.{CUGRAPH_VERSION.minor:02}"
version = f"{NXCG_VERSION.major:02}.{NXCG_VERSION.minor:02}"
# The full version, including alpha/beta/rc tags. Skipping `black` formatting
# for readability
# fmt: off
release = f"{CUGRAPH_VERSION.major:02}.{CUGRAPH_VERSION.minor:02}.{CUGRAPH_VERSION.micro:02}"
release = f"{NXCG_VERSION.major:02}.{NXCG_VERSION.minor:02}.{NXCG_VERSION.micro:02}"
# fmt: on

# The language for content autogenerated by Sphinx. Refer to documentation
Expand Down Expand Up @@ -124,7 +125,7 @@
#
html_theme_options = {
"external_links": [],
"github_url": "https://github.com/rapidsai/cugraph",
"github_url": "https://github.com/rapidsai/nx-cugraph",
"twitter_url": "https://twitter.com/rapidsai",
"show_toc_level": 1,
"navbar_align": "right",
Expand All @@ -139,7 +140,7 @@
# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = "cugraphdoc"
htmlhelp_basename = "nx-cugraphdoc"


# -- Options for LaTeX output ---------------------------------------------
Expand Down Expand Up @@ -177,7 +178,7 @@

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [(master_doc, "cugraph", "cugraph Documentation", [author], 1)]
man_pages = [(master_doc, "nx-cugraph", "nx-cugraph Documentation", [author], 1)]


# -- Options for Texinfo output -------------------------------------------
Expand All @@ -188,10 +189,10 @@
texinfo_documents = [
(
master_doc,
"cugraph",
"cugraph Documentation",
"nx-cugraph",
"nx-cugraph Documentation",
author,
"cugraph",
"nx-cugraph",
"GPU-accelerated graph analysis.",
"Miscellaneous",
),
Expand Down Expand Up @@ -226,7 +227,7 @@ def setup(app):

# 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}"
"https://github.com/rapidsai/nx_cugraph/blob/{revision}/python/{path}#L{lineno}"
)

breathe_projects = {
Expand Down

0 comments on commit ef3b496

Please sign in to comment.