Hi everyone, quick question: I am building my doc ...
# prefect-community
d
Hi everyone, quick question: I am building my doc with Sphinx and wanted to refer to the Prefect docs with intersphinx. This is relatively easy, as long as there is a public
objects.inv
but I cannot find it for Prefect… Is this supported ?
c
We use a homegrown doc generation tool that might not be compatible with Sphinx; what information does the
objects.inv
file need to contain?
d
Thanks for the quick reply Chris. Well, I am not sure what that file must contain. Normally, Sphinx generates it so I never thought about it. The format seems non trivial because you need a script to read it. For example, for pandas:
Copy code
python -m sphinx.ext.intersphinx  <http://pandas.pydata.org/pandas-docs/stable/objects.inv>
I found some docs in https://sphobjinv.readthedocs.io/en/latest/customfile.html but I do not know how complicated it would be to integrate it to your homegrown doc tool
c
Gotcha; yea that might be tricky — our homegrown tool relies on markdown, not rst, so they most likely wouldn’t be compatible
d
I think the format is not important. If I understand correctly, it’s just a catalog of attributes, classes, modules functions, etc. and where their documentation is. The idea is that Sphinx rst directives like
py:class:..
work on other projects and you can follow the link to other documentaiton. For example, again for pandas, its unzipped contents are:
Copy code
py:attribute
        pandas.Categorical.categories            reference/api/pandas.Categorical.categories.html#pandas.Categorical.categories
        pandas.Categorical.codes                 reference/api/pandas.Categorical.codes.html#pandas.Categorical.codes
...
py:class
        pandas.Categorical                       reference/api/pandas.Categorical.html#pandas.Categorical
        pandas.CategoricalDtype                  reference/api/pandas.CategoricalDtype.html#pandas.CategoricalDtype
        pandas.CategoricalIndex                  reference/api/pandas.CategoricalIndex.html#pandas.CategoricalIndex
...
c
ah I see; I know many other users are also using Sphinx docs, so I’ll look into this and see if it’s easy to provide / create
d
Cool 👍