Skip to content
This repository was archived by the owner on Mar 21, 2024. It is now read-only.

Fix contributing guide link to cmake options #1639

Merged
merged 1 commit into from
Mar 22, 2022
Merged

Fix contributing guide link to cmake options #1639

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/github_pages/contributing/submitting_a_pr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ cmake --build . -j <num jobs> # invokes make (or ninja, etc)
ctest
```

See [CMake Options](./setup/cmake_options.md) for details on customizing the build. To
See [CMake Options](../setup/cmake_options.md) for details on customizing the build. To
Copy link
Collaborator

@alliepiper alliepiper Mar 21, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

This will still be a broken link on the new doc site: https://nvidia.github.io/thrust/contributing/submitting_a_pr.html

The link is generated to point to .../cmake_options.md, but the link needs to point at a .../cmake_options.html: https://nvidia.github.io/thrust/setup/cmake_options.html

@brycelelbach Is there some doxybook magic we can use to convert the file extension in the link so that both the markdown and doxy versions will work?

Copy link
Collaborator Author

@jrhemstad jrhemstad Mar 21, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

I'm not following. The current formulation ./setup/cmake_options.md points to contributing/setup/cmake_options.md (which doesn't exist).

Wouldn't changing the relative path to ../setup to reference the parent directory correct it?

Copy link
Collaborator

Choose a reason for hiding this comment

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

There is already something in Doxybook/Jekyll that should do this (rewrite .md to .html). It's one of the Jekyll modules, I think?

Copy link
Collaborator

Choose a reason for hiding this comment

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

@brycelelbach whatever is supposed to be rewriting .md to .html in URLs is broken, because it's not happening, and the link to CMake Options generates a 404 on thrust.github.io.

enable CUB tests and examples, set the `THRUST_INCLUDE_CUB_CMAKE` option to
`ON`. Additional CMake options for CUB are listed
[here](https://github.com/NVIDIA/cub/blob/main/CONTRIBUTING.md#cmake-options).
Expand Down