Skip to content

Commit

Permalink
remove docs dependencies (#93)
Browse files Browse the repository at this point in the history
While working on rapidsai/build-planning#155, I realized that this repo no longer has any docs builds.

As far as I can tell, it's just relying on `cugraph-docs` to build and publish its docs:

* https://github.com/rapidsai/cugraph-docs/tree/branch-25.04/docs/cugraph-docs/source/nx_cugraph

If I'm right about that, then this repo doesn't need any `dependencies.yaml` entries for `sphinx` and related dependencies. This proposes removing those, along with other configuration that looks unused (possibly left-over from when this was ported out of https://github.com/rapidsai/cugraph).

## Notes for Reviewers

It looks to me like`nx-cugraph` API docs are missing, maybe unintentionally. Opened rapidsai/cugraph-docs#101 to discuss that.

I think this PR can be merged without a resolution to that conversation... if we want them, we'd likely build those docs with `sphinx.ext.autosummary` as is done for other Python docs there ([example for cugraph](https://github.com/rapidsai/cugraph-docs/blob/debf03cdb5e549b66a6f3b75d95ec836a159ea33/docs/cugraph-docs/source/api_docs/cugraph/tree.rst?plain=1#L17)).

Authors:
  - James Lamb (https://github.com/jameslamb)

Approvers:
  - Jake Awe (https://github.com/AyodeAwe)
  - Erik Welch (https://github.com/eriknw)

URL: #93
  • Loading branch information
jameslamb authored Feb 24, 2025
1 parent 7c9c868 commit 0d9b8f3
Show file tree
Hide file tree
Showing 8 changed files with 4 additions and 58 deletions.
3 changes: 1 addition & 2 deletions .flake8
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,4 @@ per-file-ignores =
__init__.py:F401,F403,
_nx_cugraph/__init__.py:E501,
nx_cugraph/__init__.py:E402,F401,F403,
benchmarks/pytest-based/create_results_summary_page.py:E501,W605,
docs/nx-cugraph/source/conf.py:E501
benchmarks/pytest-based/create_results_summary_page.py:E501,W605
2 changes: 0 additions & 2 deletions .github/workflows/pr.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,10 @@ jobs:
- '**'
- '!.devcontainer/**'
- '!README.md'
- '!docs/**'
test_python:
- '**'
- '!.devcontainer/**'
- '!README.md'
- '!docs/**'
- '!notebooks/**'
devcontainer:
secrets: inherit
Expand Down
8 changes: 0 additions & 8 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -73,14 +73,6 @@ objects.inv
# Jupyter Notebooks
.ipynb_checkpoints

## Doxygen and Docs
cpp/doxygen/html

# Sphinx docs & build artifacts
docs/nx-cugraph/source/api_docs/api/*
_html
_text

# clang tooling
compile_commands.json
.clangd/
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -76,14 +76,14 @@ repos:
- id: codespell
types_or: [python, rst, markdown]
additional_dependencies: [tomli]
files: ^(nx_cugraph|docs)/
files: ^(nx_cugraph)/
args: ["-L thirdparty,coo,COO,numer"]
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.9.6
hooks:
- id: ruff
# Don't have strict linting for miscellaneous code
args: [--extend-exclude, "benchmarks/,ci/,docs/,notebooks/"]
args: [--extend-exclude, "benchmarks/,ci/,notebooks/"]
- repo: https://github.com/rapidsai/dependency-file-generator
rev: v1.17.1
hooks:
Expand Down
4 changes: 1 addition & 3 deletions build.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/bin/bash

# Copyright (c) 2019-2024, NVIDIA CORPORATION.
# Copyright (c) 2019-2025, NVIDIA CORPORATION.

# nx-cugraph build script

Expand All @@ -25,7 +25,6 @@ VALIDARGS="
clean
uninstall
nx-cugraph
docs
all
-v
-g
Expand All @@ -41,7 +40,6 @@ HELP="$0 [<target> ...] [<flag> ...]
clean - remove all existing build artifacts and configuration (start over)
uninstall - uninstall nx-cugraph from a prior build/install (see also -n)
nx-cugraph - build the nx-cugraph Python package
docs - build the docs
all - build everything
and <flag> is:
-v - verbose build mode
Expand Down
10 changes: 0 additions & 10 deletions conda/environments/all_cuda-118_arch-x86_64.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,28 +9,18 @@ dependencies:
- cuda-version=11.8
- cudf==25.4.*,>=0.0.0a0
- cupy>=12.0.0
- graphviz
- ipython
- nbsphinx
- networkx>=3.2
- numpy>=1.23,<3.0a0
- numpydoc
- pandas
- pre-commit
- pydata-sphinx-theme
- pylibcugraph==25.4.*,>=0.0.0a0
- pytest
- pytest-benchmark
- pytest-cov
- pytest-mpl
- pytest-xdist
- rapids-build-backend>=0.3.1,<0.4.0.dev0
- recommonmark
- scipy
- setuptools>=61.0.0
- sphinx
- sphinx-copybutton
- sphinx-markdown-tables
- sphinxcontrib-websupport
- wheel
name: all_cuda-118_arch-x86_64
10 changes: 0 additions & 10 deletions conda/environments/all_cuda-128_arch-x86_64.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,28 +9,18 @@ dependencies:
- cuda-version=12.8
- cudf==25.4.*,>=0.0.0a0
- cupy>=12.0.0
- graphviz
- ipython
- nbsphinx
- networkx>=3.2
- numpy>=1.23,<3.0a0
- numpydoc
- pandas
- pre-commit
- pydata-sphinx-theme
- pylibcugraph==25.4.*,>=0.0.0a0
- pytest
- pytest-benchmark
- pytest-cov
- pytest-mpl
- pytest-xdist
- rapids-build-backend>=0.3.1,<0.4.0.dev0
- recommonmark
- scipy
- setuptools>=61.0.0
- sphinx
- sphinx-copybutton
- sphinx-markdown-tables
- sphinxcontrib-websupport
- wheel
name: all_cuda-128_arch-x86_64
21 changes: 0 additions & 21 deletions dependencies.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ files:
includes:
- checks
- cuda_version
- docs
- python_build_rapids
- python_build_wheel
- test_python_common
Expand All @@ -22,12 +21,6 @@ files:
includes:
- checks
- py_version
docs:
output: none
includes:
- cuda_version
- docs
- py_version
test_notebooks:
output: none
includes:
Expand Down Expand Up @@ -123,20 +116,6 @@ dependencies:
- output_types: conda
packages:
- nx-cugraph==25.4.*,>=0.0.0a0
docs:
common:
- output_types: [conda]
packages:
- graphviz
- ipython
- nbsphinx
- numpydoc
- pydata-sphinx-theme
- recommonmark
- sphinx-copybutton
- sphinx-markdown-tables
- sphinx
- sphinxcontrib-websupport
py_version:
specific:
- output_types: [conda]
Expand Down

0 comments on commit 0d9b8f3

Please sign in to comment.