Skip to content
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.

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

remove docs dependencies #93

Merged
merged 2 commits into from
Feb 24, 2025

Conversation

jameslamb
Copy link
Member

@jameslamb jameslamb commented Feb 21, 2025

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:

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 likenx-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).

@jameslamb jameslamb added improvement Improves an existing functionality non-breaking Introduces a non-breaking change labels Feb 21, 2025
Copy link

copy-pr-bot bot commented Feb 21, 2025

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@github-actions github-actions bot added the conda Relates to conda packaging label Feb 21, 2025
@jameslamb
Copy link
Member Author

/ok to test

@jameslamb jameslamb changed the title WIP: remove docs dependencies remove docs dependencies Feb 21, 2025
@jameslamb jameslamb marked this pull request as ready for review February 21, 2025 19:19
@jameslamb jameslamb requested a review from a team as a code owner February 21, 2025 19:19
@jameslamb jameslamb requested a review from AyodeAwe February 21, 2025 19:19
Copy link
Contributor

@eriknw eriknw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These changes look good to me. Shall we also remove the docs target from build.sh?

Also, how should we handle docs requests for this repo? Should we accept them here, or point them to cugraph-docs repo? That is, should we update the issue templates docs_request_new.yaml or docs_request_correction.yaml?

@jameslamb jameslamb requested a review from a team as a code owner February 21, 2025 20:19
@jameslamb
Copy link
Member Author

jameslamb commented Feb 21, 2025

Shall we also remove the docs target from build.sh?

Good idea! Just did that (and removed a few more places where configuration pointed at the nonexistent docs/ directory) here: 3a6a0f2

should we update the issue templates docs_request_new.yaml or docs_request_correction.yaml?

I think that depends on the outcome of rapidsai/cugraph-docs#101

If that issues goes the way I think it'll go, then nx-cugraph docs will be sourced from 2 places:

  • this repo: Python code and its docstrings (for API docs)
  • cugraph-docs repo: other long-form docs (and notebooks one day?) (code link)

It's up to you all (and including @acostadon ) what you think will provide the best experience for users and outside contributors.

Copy link
Contributor

@eriknw eriknw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @jameslamb! This was something we were unsure of during the repo migration.

@jameslamb
Copy link
Member Author

/merge

@rapids-bot rapids-bot bot merged commit 0d9b8f3 into rapidsai:branch-25.04 Feb 24, 2025
32 checks passed
@jameslamb jameslamb deleted the remove-docs-deps branch February 24, 2025 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
conda Relates to conda packaging improvement Improves an existing functionality non-breaking Introduces a non-breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants