Django

Code

Ticket #10315 (closed: fixed)

Opened 1 year ago

Last modified 10 months ago

objects.inv not available for intersphinx

Reported by: awatts Assigned to: jacob
Milestone: Component: Documentation
Version: 1.0 Keywords:
Cc: Triage Stage: Accepted
Has patch: 0 Needs documentation: 0
Needs tests: 0 Patch needs improvement: 0

Description

I'm writing documentation for my Django app, and I'm using Sphinx with the intersphinx extension. I'd like to be able to cross-reference Django modules, but http://docs.djangoproject.com/en/dev/objects.inv either doesn't exist or is not served. Currently I'm making my own ad hoc inventory file, but it would be nice if I could reference the real one.

See http://docs.python.org/objects.inv as an example of a site that does provide the cross-referencing information.

Attachments

Change History

02/28/09 12:54:43 changed by jacob

  • status changed from new to assigned.
  • needs_better_patch changed.
  • needs_tests changed.
  • owner changed from nobody to jacob.
  • needs_docs changed.
  • stage changed from Unreviewed to Accepted.

03/16/09 15:54:58 changed by jacob

  • status changed from assigned to closed.
  • resolution set to fixed.

(In [10069]) [djangoproject.com] Expose objects.inv for intersphinx links. Fixes #10315.

03/16/09 15:55:27 changed by jacob

05/19/09 10:43:57 changed by ben

It might also be worth mentioning here that you'll need to download this and stick it in your sphinx source directory (as django.inv in the conf.py example below). Then you need something in conf.py like this:

intersphinx_mapping = {
  'http://docs.djangoproject.com/en/dev': 'django.inv',
  }

This doesn't guarantee that your link to a django object will be picked up. If you get something like this:

Exception occurred: 60%] index                                           
  File ".../writers/html.py", line 478, in unknown_visit
    raise NotImplementedError('Unknown node: ' + node.__class__.__name__)
NotImplementedError: Unknown node: pending_xref
The full traceback has been saved in /tmp/sphinx-err-z5XcJy.log, if you want to report the issue to the author.

Then check that it's in the inv file.


Add/Change #10315 (objects.inv not available for intersphinx)




Change Properties
Action