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

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

Open
1 task done
ahendriksen opened this issue Jan 22, 2024 · 1 comment
Open
1 task done

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

ahendriksen opened this issue Jan 22, 2024 · 1 comment
Assignees
Labels
doc Documentation-related items.

Comments

@ahendriksen
Copy link
Contributor

Is this a duplicate?

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:

./docs/serve

It seems that the currently configured base_url (link) 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

@ahendriksen ahendriksen added the doc Documentation-related items. label Jan 22, 2024
@wmaxey
Copy link
Member

wmaxey commented Jan 24, 2024

Perhaps a solution is to supply the baseurl during our build of libcudacxx docs rather than build them assuming they are under CCCL.

Thanks for the heads up. I'll consider this when I begin touching the docs again unless someone beats me to it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation-related items.
Projects
Status: Todo
Development

No branches or pull requests

2 participants