Intersphinx linking to properties not working

[DominicDirkx]

As discussed in the first couple of posts in #25:
#25 (comment)
we currently have no way of using intersphinx to use links to the tudatpy API docs for class properties. This should be resolved to allow full linking between tudat-space and API docs. Since properties are usually mentioned in the context of the linked class that they belong to, this issue does not have high priority

[FilippoOggionni]

The same problem happens for modules. I tried with :mod: but it does not work.

[DominicDirkx]

That's weird, I hadn't tried that yet. If we don't manage to resolve this soon-ish, we could put in direct URL links, pending the resolution of this issue, as a temporary working solution

[FilippoOggionni]

I agree. Let's see if we can get @ggarrett13's view on it in the next few days, otherwise I agree on temporarily switching to regular URL links for now

[geoffreygarrett]

Apologies for the late reply. I saw the original thread in #25 and saw it closed, did not see this one.

links to the tudatpy API docs for class properties

I don't think there is a solution for linking directly to a class' properties. The following approach may be a good alternative:

... as determined by property_X of :class:Class_X

Where the latter is linked and former is not.

[geoffreygarrett]

Actually, I found this. I don't know if it works only within the same project, or if it works for linking to external projects. Give it a go, but I consider this issue closed.

[FilippoOggionni]

The link posted by @ggarrett13 unfortunately does not solve the issue. While the workaround for properties holds, this does not work for modules (neither :mod: nor the generic :obj: tags work).

[FilippoOggionni]

Potentially useful material: see this comment

[FilippoOggionni]

Resource