Opened 3 years ago

Last modified 3 months ago

#27164 new defect

link sphinx docs of Sage components in reference manual

Reported by: dimpase Owned by:
Priority: critical Milestone: sage-9.5
Component: documentation Keywords:
Cc: embray, fbissey, arojas, gh-timokau, infinity0 Merged in:
Authors: Reviewers:
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description (last modified by vdelecroix)

As Sage gets increasingly modular, it becomes important (also for the doc website, currently it has broken links to e.g. sagenb interacts in the reference manual) that these spun off docs are still easy to find.

In fact, sphinx has an extension to link different projects, see http://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html

so this appears quite doable. Here is an incomplete docs to link

  • sagetex
  • sagenb (see #25382)
  • cypari
  • cysignals
  • pplpy (not yet in Sage, see #23024)

Change History (12)

comment:1 follow-up: Changed 3 years ago by vdelecroix

  • Description modified (diff)

Question: how does this intersphinx will interplay with distribution installation (e.g. Gentoo, Archlinux, Debian, etc)?

comment:2 in reply to: ↑ 1 Changed 3 years ago by dimpase

  • Cc embray fbissey arojas gh-timokau infinity0 added

Replying to vdelecroix:

Question: how does this intersphinx will interplay with distribution installation (e.g. Gentoo, Archlinux, Debian, etc)?

This is a question for packagers. I have no idea what they do with Sage's docs. I cc'd the packagers I can think of.

comment:3 follow-up: Changed 3 years ago by gh-timokau

I don't know much about intersphinx. Doesn't it simply link to online resources? Or does it also link offline docs together?

comment:4 in reply to: ↑ 3 Changed 3 years ago by vklein

Replying to gh-timokau:

I don't know much about intersphinx. Doesn't it simply link to online resources? Or does it also link offline docs together?

It can do both. When you declare a mapping let's say for numpy:

intersphinx_mapping = {'numpy': (URI, None)}

URI can be an online link or your numpy's documentation local directory.

comment:5 Changed 3 years ago by gh-timokau

Well then as long as sage does The Right Thing with the URI, it shouldn't be an issue with packaging.

comment:6 Changed 3 years ago by embray

  • Milestone changed from sage-8.7 to sage-8.8

Moving all blocker/critical issues from 8.7 to 8.8.

comment:7 Changed 2 years ago by embray

  • Milestone changed from sage-8.8 to sage-8.9

Moving open critical and blocker issues to the next release milestone (optimistically).

comment:8 Changed 22 months ago by embray

  • Milestone changed from sage-8.9 to sage-9.1

Ticket retargeted after milestone closed

comment:9 Changed 18 months ago by mkoeppe

  • Milestone changed from sage-9.1 to sage-9.2

comment:10 Changed 12 months ago by mkoeppe

  • Milestone changed from sage-9.2 to sage-9.3

comment:11 Changed 7 months ago by mkoeppe

  • Milestone changed from sage-9.3 to sage-9.4

Sage development has entered the release candidate phase for 9.3. Setting a new milestone for this ticket based on a cursory review of ticket status, priority, and last modification date.

comment:12 Changed 3 months ago by mkoeppe

  • Milestone changed from sage-9.4 to sage-9.5
Note: See TracTickets for help on using tickets.