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

Update documentation #484

Open
3 of 6 tasks
IceflowRE opened this issue Sep 1, 2022 · 2 comments
Open
3 of 6 tasks

Update documentation #484

IceflowRE opened this issue Sep 1, 2022 · 2 comments
Assignees
Labels
cat:bug bug/error/mistake which limits the program cat:documentation documentation cat:enhancement enhancement/requested feature/update of existing features

Comments

@IceflowRE
Copy link
Member

IceflowRE commented Sep 1, 2022

@IceflowRE IceflowRE added cat:documentation documentation cat:enhancement enhancement/requested feature/update of existing features cat:bug bug/error/mistake which limits the program labels Sep 1, 2022
@IceflowRE IceflowRE self-assigned this Sep 1, 2022
@IceflowRE
Copy link
Member Author

The issue is that we include generated files in a toctree, this behaviour was changed in svenevs/exhale#136. Those files are now excluded.

Waiting for response.

@IceflowRE IceflowRE added org:on hold on hold, until ... org:third party this issue depends on a third party project and is out of our hands labels Sep 10, 2022
@IAmNotHanni
Copy link
Member

IAmNotHanni commented Sep 18, 2022

I had this idea:

Let's imagine I'm writing a documentation for a function which uses vkEnumerateDeviceExtensionProperties.
I could add a link to the Vulkan spec in the comments like this:

/// Call [vkEnumerateDeviceExtensionProperties](https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkEnumerateDeviceExtensionProperties.html)

This is what it could look like in the docs: The vkEnumerateDeviceExtensionProperties function has a link to the Vulkan spec! Nice!

grafik

However, wouldn't it be better to let Sphinx search for vkEnumerateDeviceExtensionProperties in the comments and add the link automatically? We could extend this idea to all Vulkan resources! We could simply make a list for which links to put int.

We don't need to worry about keeping the links up to date too much because the Vulkan spec page will redirect to the newest spec version anyways as far as I know.

I will close issue #261 in favor of this one.

@IceflowRE IceflowRE removed org:on hold on hold, until ... org:third party this issue depends on a third party project and is out of our hands labels Oct 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cat:bug bug/error/mistake which limits the program cat:documentation documentation cat:enhancement enhancement/requested feature/update of existing features
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

2 participants