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.

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

Jump to bottom

Cross link RMM & libcudf Doxygen docs [skip-ci] #7149

Merged
merged 6 commits into from
Jan 20, 2021
Merged

Cross link RMM & libcudf Doxygen docs [skip-ci] #7149

merged 6 commits into from
Jan 20, 2021

Conversation

ajschmidt8
Copy link
Member

This PR updates cpp/doxygen/Doxyfile to consume the generated Doxygen tags from rmm (see rapidsai/rmm#672). This will enable linking between the cudf docs and rmm docs.

This PR along with rapidsai/rmm#672 closes issue #5152.

I also updated docs/cudf/source/conf.py and added it to update-version.sh.

@ajschmidt8 ajschmidt8 added doc Documentation non-breaking Non-breaking change labels Jan 14, 2021
@ajschmidt8 ajschmidt8 requested review from a team as code owners January 14, 2021 22:24
@ajschmidt8 ajschmidt8 mentioned this pull request Jan 14, 2021
Closed
vuule
vuule approved these changes Jan 14, 2021
View reviewed changes
Copy link
Contributor

@vuule vuule left a comment

Choose a reason for hiding this comment

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

I don't fully understand what this does, approving to meet the cpp-owners requirement (no C++ changes anyway).

nvdbaranec
nvdbaranec approved these changes Jan 14, 2021
View reviewed changes
Copy link
Contributor

@nvdbaranec nvdbaranec left a comment

Choose a reason for hiding this comment

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

I echo Vukasin's comments :)

@ajschmidt8
Copy link
Member Author

I don't fully understand what this does, approving to meet the cpp-owners requirement (no C++ changes anyway).

I echo Vukasin's comments :)

@vuule, @nvdbaranec this PR makes it so that when people see an rmm reference in the cudf docs (highlighted in the screenshot), they can click it and it will link them directly to the correct rmm documentation page.

image

karthikeyann
karthikeyann requested changes Jan 15, 2021
View reviewed changes
ci/docs/build.sh Show resolved Hide resolved
@harrism
Copy link
Member

harrism commented Jan 18, 2021

Fixes #5152

@harrism harrism changed the title Cross link rmm & cudf docs [skip-ci] Cross link RMM & libcudf docs [skip-ci] Jan 18, 2021
@harrism harrism changed the title Cross link RMM & libcudf docs [skip-ci] Cross link RMM & libcudf Doxygen docs [skip-ci] Jan 18, 2021
@harrism harrism linked an issue Jan 18, 2021 that may be closed by this pull request
[DOC] cross link rmm and cudf documentation #5152
Closed
@rapids-bot rapids-bot bot merged commit d79da2c into rapidsai:branch-0.18 Jan 20, 2021
@revans2 revans2 mentioned this pull request Feb 24, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@harrism harrism harrism left review comments

@nvdbaranec nvdbaranec nvdbaranec approved these changes

@dillon-cullinan dillon-cullinan dillon-cullinan approved these changes

@vuule vuule vuule approved these changes

@karthikeyann karthikeyann karthikeyann approved these changes

Assignees
No one assigned
Labels
doc Documentation non-breaking Non-breaking change
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[DOC] cross link rmm and cudf documentation
6 participants
@ajschmidt8 @harrism @karthikeyann @vuule @dillon-cullinan @nvdbaranec