NVIDIA / NVIDIA/cccl

[DOC]: Instructions for hosting docs locally don't work

Open
#1,309 1 comment 0 reactions 1 assignee Claimed by @wmaxey View on GitHub
Dominant language
C++
Stars
2.5k
Forks
487
Avg merge
2d 7h
Merged PRs (30d)
296

Description

### Is this a duplicate?

- [X] I confirmed there appear to be no [duplicate issues](https://github.com/NVIDIA/cccl/issues) for this bug and that I agree to the [Code of Conduct](CODE_OF_CONDUCT.md)

### Is this for new documentation, or an update to existing docs?

New

### Describe the incorrect/future/missing documentation

The following instructions from `cccl/libcudacxx/docs/readme.md` don't work flawlessly:

> To build and serve the documentation as a website to `http://localhost:4000` just execute the following from libcudacxx root directory:

```shell
./docs/serve
```

It seems that the currently configured `base_url` [(link](https://github.com/NVIDIA/cccl/blob/54fd4c00a8a796d4d4497ccd82651768539d5e30/libcudacxx/docs/_config.yml#L16)) does not work when hosting locally with a port.

The following change solves the problem locally, but not sure if that affects the hosted docs:
```
baseurl: "/cccl/libcudacxx"
```

### If this is a correction, please provide a link to the incorrect documentation. If this is a new documentation request, please link to where you have looked.

https://github.com/NVIDIA/cccl/tree/main/libcudacxx/docs

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.