intel / intel/llvm

Broken section links in environment variables generated documentation

Open
#7,539 2 comments 1 reaction 0 assignees View on GitHub
bug confirmed Documentation
Dominant language
LLVM
Stars
1.5k
Forks
854
Avg merge
3d 17h
Merged PRs (30d)
137

Description

On this page:
* https://intel.github.io/llvm-docs/EnvironmentVariables.html

The "See below" links in the environment variables table are broken, it seems that sphinx is turning the `_` into `-` when generating the title anchors, see:

This link goes to the correct location:
* https://intel.github.io/llvm-docs/EnvironmentVariables.html#oneapi-device-selector

This link doesn't:
* https://intel.github.io/llvm-docs/EnvironmentVariables.html#oneapi_device_selector

But the second one is the anchor that is used in the table for the "See below" links.

In the github rendered version the generated title anchors don't modify the `_`, so the links are working properly, see:

* https://github.com/intel/llvm/blob/sycl/sycl/doc/EnvironmentVariables.md#oneapi_device_selector

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.