Hi Martin,
Thank you for the suggestion. I added the intersphinx extension, created an
jira-objects.txt' from scratch following the sphobjinv
<https://sphobjinv.readthedocs.io/en/latest/syntax.html> guide, compressed
to jira-objects.inv using the sphobjinv
<https://github.com/bskinn/sphobjinv> converter.... However I haven't been
able to understand the format for either objects.inv or cross references.
Perhaps someone can see my error...
jira-objects.txt (compressed to jira-objects.inv)
# Sphinx inventory version 2
# Project: JIRA
# Version:
# The remainder of this file is compressed using zlib.
ABC-1234 std:label 1 #$ This is an example JIRA ticket reference.
conf.py includes this option:
intersphinx_mapping = {'jira': ('https://example.atlassian.net/browse',
'jira-objects.inv')}
Within a page I then tried a number of ways to reference ABC-1234 with no
luck.
Example 1:
Reference to :ref:`ABC-1234`.
Produces:
Reference to ABC-1234.
(No link, styling or display name shown.)
Example 2:
Reference to :label:`ABC-1234`..
Produces:
Reference to :label:`ABC-1234` testing.
With a broken link to #id1.
I was not sure what to put for the domain, role or URI. I am hoping for
output like the following:
Reference to ABC-1234 <https://example.atlassian.com/browse/ABC-1234>.
and
Reference to ABC-1234 This is an example JIRA ticket reference.
<https://example.atlassian.com/browse/ABC-1234>.
The link is simply the the name/id appended to the base URL that I
specified in the conf.py intersphinx_mapping option, i.e.
https://example.atlassian.com/browse/ABC-1234.
Any additional help would be greatly appreciated!
Thanks,
Ed
On Thursday, October 29, 2020 at 5:29:29 PM UTC-4 [email protected] wrote:
> Hello,
>
> > I am just learning Sphinx and would appreciate guidance on the best
> > way to insert links to external records. Specifically wanting to write
> > product documentation in Sphinx and link to corresponding API
> > documentation,
>
> what we did for a while in TYPO3 documentation (https://docs.typo3.org)
> was:
>
> - use a script to create an 'objects.inv' file for tha API urls
>
> - then use normal intersphinx crossreferencing.
>
> Follow these explanations:
> https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html
>
> This works totally fine. However we gave up on this as our API was
> changing too much from version to version and we didn't need that many
> links.
>
> Martin Bless
>
>
>
--
You received this message because you are subscribed to the Google Groups
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/sphinx-users/71f89243-8cda-4c7c-b735-2467528209a4n%40googlegroups.com.
