Intersphinx Mapping Request

[madeline-scyphers]

🚀 Feature Request

I am working on a project that uses sphinx to build the docs. We use intersphinx to cross link to other projects and we would like to link to Botorch for type hints and other resources. Because in Botorch's docs scripts, after you build your docs with sphinx, you copy the html files for docusaurus and then the build doesn't have access to the generated objects.inv the gives the inventory of objects for intersphinx linking. Without it, you can't do the intersphinx mapping.

Motivation

Is your feature request related to a problem? Please describe.

Sphinx is widely used as the de facto documentation tool in python, and with it comes the great ability to automatically add non hardcoded links to other people's source code. When people move a class to a different module, your link doesn't break. Botorch already builds its docs with Sphinx, but because it uses docusaurus instead of html templates, you remove the files from sphinx, removing some of the benefits that other libraries might get.

Pitch

Describe the solution you'd like

I am not sure if it would be possible, but maybe if you also copy the objects.inv over as well. It usually goes in the same folder as your index.html file, which is usually in the created _build directory in sphinx, but that directory isn't there, so if you all did do this, maybe where index.html is, so in the api folder in the gh_pages branch.

Describe alternatives you've considered
You could probably get the same website with a custom sphinx html template instead of docusaurus.

Potentially

Additional context

You can see here a way to check if the intersphinx mapping works from command line at the bottom of this page

[Balandat]

Our setup is pretty much the same as Ax's, so let's move the discussions of the technical aspects of this to facebook/Ax#1227.