question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Enable intersphinx by hosting objects.inv

See original GitHub issue

Is your feature request related to a problem? Please describe. I would like to link to parts of the geoviews documentation using the sphinx intersphinx extension. I’m 90% sure this used to work, but doesn’t any more. The main thing is that there needs to be a /objects.inv hosted in the documentation. My understanding is this happens by default with normal sphinx builds:

https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html

Describe the solution you’d like

https://geoviews.org/objects.inv

Is it possible this file is not being included on purpose? Sphinx is still being used for documentation site generation, right?

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Comments:6 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
philippjfrcommented, Mar 26, 2020

Finally fixed, sorry for the delay.

1reaction
ceballcommented, Dec 3, 2019

It might have been deliberate, but mistaken.

Here’s an example of the file being removed from the geoviews website build:

[...]
copying static files... ... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 29 warnings.
The HTML pages are in ../builtdocs.
/home/travis/miniconda/envs/test-environment/bin/nbsite_fix_links.py:111: UserWarning: Found missing link ./user_guide/Gridded_Datasets_II.html in: builtdocs/user_guide/Resampling_Grids.html. 
  warnings.warn('Found missing link {} in: {}. {}'.format(a['href'], path, also_tried))
Removing files from: /home/travis/build/holoviz/geoviews/builtdocs
removing .doctrees
removing _sources
removing objects.inv
Copying json blobs (used for holomaps) from /home/travis/build/holoviz/geoviews/doc to builtdocs
cp /home/travis/build/holoviz/geoviews/doc/9a26dd393dba4610bbd10696d678d46f.json builtdocs/9a26dd393dba4610bbd10696d678d46f.json
cp /home/travis/build/holoviz/geoviews/doc/gallery/matplotlib/d36be3bff5dc4661acf267f72f89a1bd.json builtdocs/gallery/matplotlib/d36be3bff5dc4661acf267f72f89a1bd.json
[...]

(https://travis-ci.org/holoviz/geoviews/jobs/617439369#L2234)

I’ve opened https://github.com/pyviz-dev/nbsite/issues/153

Read more comments on GitHub >

github_iconTop Results From Across the Web

sphinx.ext.intersphinx – Link to other projects' documentation
Each Sphinx HTML build creates a file named objects. · Projects using the Intersphinx extension can specify the location of such mapping files...
Read more >
Welcome to sphobjinv! — sphobjinv 2.2.2 documentation
¶. A toolkit for inspection/manipulation of Sphinx objects inventories. When documentation is built using, e.g., Sphinx's StandaloneHTMLBuilder , an inventory ...
Read more >
sphobjinv - PyPI
sphobjinv (short for 'sphinx objects.inv') can help! The syntax required for a functional Sphinx cross-reference is highly non-obvious in many ...
Read more >
Linking Between Sites with Intersphinx - PyCharm Guide
Rich structure and linking, between sites. Perhaps you've gotten the point by now: Sphinx extracts a lot of structure in your site. But...
Read more >
Sphinx Objects.inv Converter Documentation - Read the Docs
inv files in order to allow intersphinx cross-referencing of other documentation sets that were not created by Sphinx. Install via pip: $ pip...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found