New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Intersphinx from local folder #741
Comments
Hello @miloth, There is currently no way to include local objects.inv file. But support for this could be relatively easy to add. Maybe adding an new option —intersphinx-file. Looking at the file sphinx.py would be a good starting point. |
Better, we could simply add support for the file:// scheme. |
Hi @tristanlatr, thanks for the response and the suggestions. I don't have hours available to allocate to this, but I will get back to it if I find some. I don't know if the url |
I think the is a misunderstanding, I’m not proposing to generate links with the file:// scheme, but to use the file:// scheme in the intersphinx list configuration to differentiate local and remote objects.inv. But, thinking about it twice: it’s probably misguided because the file:// scheme theoretically also support providing a remote host to fetch the file from… Any opinion about this @glyph ? |
technically speaking, |
Easier: if the string doesn’t contain |
Hi,
We have some privately hosted repos and docs. We are trying to link to those during our docs generation by using locally cloned versions. Yet, if this is in the config:
pydoctor
throws the following warning:Is there a way to add references to local files, like with the
intershinx-mapping
option ofsphinx
:The path to the
inv
file could be absolute or relative, no real preference on what is more convenient.Thanks!
The text was updated successfully, but these errors were encountered: