Project

Profile

Help

Task #939

Document how intersphinx linking works

Added by dkliban@redhat.com over 5 years ago. Updated 26 days ago.

Status:
CLOSED - NOTABUG
Priority:
Normal
Assignee:
-
Category:
-
Sprint/Milestone:
-
Start date:
Due date:
% Done:

0%

Estimated time:
Platform Release:
Groomed:
Yes
Sprint Candidate:
No
Tags:
Documentation, Pulp 2
Sprint:
Quarter:

Description

Documentation should be added to http://pulp.readthedocs.org/en/latest/dev-guide/contributing/documenting.html#editing-the-docs

When you want to reference docs of any of the projects mentioned in `intersphinx_mapping` just add the following code:

:ref:`importer config docs <puppet:configuration>`

The above example relies on 'puppet' being defined in `intersphinx_mapping`. It also relies on a label called 'configuration' existing in the puppet docs.
A list of all labels for a project can be found by using this script: https://gist.github.com/dkliban/683c3e9cdfc1ba884226/c8c3e0e10fef5dbe7525cd1b1137357e93862685

Save the gist as an executable called `inventory.py` and then invoke the following command:

./inventory.py --url http://pulp-puppet.readthedocs.org/en/2.6-release/objects.inv

The URL can point to any RTD builder. Each of our builders generates an objects.inv each time the docs are built.

If you don't see the label that you wish to link to, then you need to create one. A label can be created by adding the following tag:

.. _label1:

The above code will create a label1 that can be reference externally. If `label1` was added to the `puppet` project then it can be referenced with:

:ref:`importer config docs <puppet:label1>`

History

#1 Updated by dkliban@redhat.com over 5 years ago

  • Description updated (diff)

#2 Updated by mhrivnak over 5 years ago

  • Tracker changed from Issue to Task
  • Tags Sprint Candidate added

#3 Updated by bmbouter over 5 years ago

  • Groomed set to No
  • Sprint Candidate set to Yes
  • Tags deleted (Sprint Candidate)

#4 Updated by mhrivnak over 5 years ago

  • Groomed changed from No to Yes

#5 Updated by mhrivnak over 4 years ago

  • Sprint Candidate changed from Yes to No

#6 Updated by bmbouter about 4 years ago

  • Status changed from NEW to CLOSED - NOTABUG

We no longer use intersphinx with the new docs site so I'm closing this as NOTABUG based on the current state.

#7 Updated by bmbouter over 1 year ago

  • Tags Pulp 2 added

Please register to edit this issue

Also available in: Atom PDF