Skip to content

Conversation

@aidanfnv
Copy link
Contributor

@aidanfnv aidanfnv commented May 2, 2025

For #72

This replaces the external links to the Slang User Guide in the readthedocs index file with references to the internal copy in the submodule. Also adds explicit include matching for the docs, to avoid wasting time building HTML files for docs that do not belong on the readthedocs site.

See https://shader-slanggithubio-aidanfnv-wip.readthedocs.io/en/fix-readthedocs-user-guide/ for what the site looks like on this branch.
The sidebar will not expand to show any content in the user guide yet until it has a compatible table of contents, see shader-slang/slang#6979

@aidanfnv aidanfnv marked this pull request as ready for review May 2, 2025 05:19
@aidanfnv aidanfnv requested a review from jkwak-work May 2, 2025 05:27
Copy link
Contributor

@jkwak-work jkwak-work left a comment

Choose a reason for hiding this comment

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

Looks good to me

@aidanfnv aidanfnv merged commit da3ac4b into shader-slang:main May 2, 2025
@aidanfnv aidanfnv deleted the fix/readthedocs-user-guide branch May 10, 2025 00:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants