Update documentation

[IceflowRE]

• [ ] Update frontpage to match the current Readme
• [x] Fix source code documentation build (https://docs.readthedocs.io/en/stable/config-file/v2.html#build-jobs)
• [x] Enable builds for PR decided against it, we already build the docs, we can download them in case
• [ ] https://inexor-vulkan-renderer.readthedocs.io/en/latest/development/building.html
• [ ] Remove atom from recommended software
• [x] Add intersphinx for Vulkan
  • https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html#
  • https://docs.typo3.org/typo3cms/extensions/sphinx/2.5.1/AdvancedUsersManual/AdvancedCrossLinks/Index.html
  • https://github.com/sphinx-doc/sphinx/pull/8929

[IceflowRE]

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

Waiting for response.

[IAmNotHanni]

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!

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 https://github.com/inexorgame/vulkan-renderer/issues/261 in favor of this one.