intersphinx mapping

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 Ax for type hints and other resources. Because in Ax’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.

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.

See related Botorch issue https://github.com/pytorch/botorch/issues/1464

[madeline-scyphers]

@pcanaran

Thanks!

1. Instructions to validate can be found here at the bottom. There is a command line instructions. It should look something like this

    python -m sphinx.ext.intersphinx https://ax.dev/api/objects.inv 
   

   or

    python -m sphinx.ext.intersphinx https://ax.dev/objects.inv 
   

   depending on where the objects.inv is.

2. https://github.com/madeline-scyphers/boa is the project. Has in the intersphinx section one intersphinx linking. On this docs update branch there are more examples

[pcanaran]

@madeline-scyphers Unfortunately we didn’t have a chance to get to this. I added it to our wishlist tracking issue #566. Closing this one as we have tracking there. In the mean time if you prefer you can also send a PR instead. Thank you.