Static Sites with Sphinx and Markdown Transcripts
Chapter: Linking between sites
Lecture: Setting up intersphinx
Login or
purchase this course
to watch this video and the rest of the course contents.
0:00
Inter Sphinx is a sphinx extension.
0:03
It's bundled with Sphinx but it isn't on by default.
0:07
Let's quickly show enabling it and setting it up.
0:11
I'm back in my sphinx .conf file and in the extensions to Sphinx I want
0:17
to add an entry to turn on 'sphinx.ext.intersphinx'.
0:25
Now that the extension is loaded,
0:28
I need to do a little bit of configuration for it.
0:30
I need to point it at the external websites that has Sphinx inventories available that I
0:38
would like to use in my website.
0:41
So the first thing I want to add is the inter sphinx mapping which says when
0:47
I'm doing links in my sight and I put the special prefix on it called Sphinx
0:53
which we'll see in a bit.
0:55
Then that comes from the intersphinx inventory at this URL.
1:02
And you're basically telling Sphinx hey you gotta go download this special file at that place
1:06
I have one other thing I have to do with MyST which is turn on
1:12
this URL. Schemes thing to allow MyST to work correctly with some of the
1:17
URL Syntax. And with this now set up we will start using it and see it how downloads the inevntory files.