Join Slack

Does prefect support <intersphinx> for documentation purposes?

# ask-community

Constantino Schillebeeckx

08/20/2021, 4:15 PM

Does prefect support intersphinx for documentation purposes?

Kevin Kho

08/20/2021, 4:20 PM

Hey, is the question

sphinx

in general or

intersphinx

specifically?

Constantino Schillebeeckx

08/20/2021, 4:21 PM

in order to support intersphinx, I need to point it add an index of all the documentation

Constantino Schillebeeckx

08/20/2021, 4:23 PM

how do you all build your docs?

Kevin Kho

08/20/2021, 4:23 PM

custom in-house tool 😅

Constantino Schillebeeckx

08/20/2021, 4:23 PM

sadness

Constantino Schillebeeckx

08/20/2021, 4:23 PM

for reference:

Each Sphinx HTML build creates a file named
objects.inv
that contains a mapping from object names to URIs relative to the HTML set’s root.

Projects using the Intersphinx extension can specify the location of such mapping files in the intersphinx_mapping
config value. The mapping will then be used to resolve otherwise missing references to objects into links to the other documentation.

Constantino Schillebeeckx

08/20/2021, 4:24 PM

well that answers my question then; I can't directly link to your docs using Sphinx

Constantino Schillebeeckx

08/20/2021, 4:24 PM

thanks for the help @Kevin Kho

👍 1

Open in Slack

Previous Next

Prefect Community

Bring your towel and join one of the fastest growing data communities. Welcome to our second-generation open source orchestration platform, a completely rethought approach to dataflow automation.