Add intersphinx configuration #28
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Intersphinx is an extension that comes installed with Sphinx that can generate links to the documentation of objects in external projects. By enabling this extension, an `objects.inv` file will be created when building the documentation. With this file, other projects can easily link to this guide using `ref` and `doc` directives, *e.g*, :ref:`django-views-right-way:starting-point`. This extension can also be useful to automatically add links to Django modules and classes, *e.g*, :func:`~django.shortcuts.render` would automatically be converted into a link to the Django docs page for that function. See: https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Intersphinx is an extension that comes installed with Sphinx that can generate links to the documentation of objects in external projects.
By enabling this extension, an
objects.invfile will be created when building the documentation. With this file, other projects can easily link to this guide usingrefanddocdirectives, e.g, :ref:django-views-right-way:starting-point.This extension can also be useful to automatically add links to Django modules and classes, e.g,
:func:~django.shortcuts.render` would automatically be converted into a link to the Django docs page for that function.See: https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html