Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use intersphinx links for links to the CrateDB docs
Sphinx has an extension called "intersphinx" (https://www.sphinx-doc.org/en/3.x/usage/extensions/intersphinx.html) which allows cross-referencing multiple Sphinx projects. By relying on the extension, dead links can be detected earlier. Additionally, it adds the same semantics and contextual details for links between documentation projects. For example, a link from the CrateDB Kubernetes Operator docs to something in its code, would look like this: :func:`crate.operator.main.create` Linking to a function in another project, listed in the `intersphinx_mapping` could be :func:`kopf:kopf.on.create` In both cases, Sphinx will know that it's linking to a function, thus using the correct visual attributes when rendering the HTML. Unlike linking to the URL directly, which would only show as a regular link.
- Loading branch information