Hello, On Tue, Jun 15, 2010 at 7:36 AM, Florent Hivert <florent.hiv...@univ-rouen.fr> wrote: > Hi there, > > I'd like to have some crossref back and forth from sage source __doc__ to some > rst file under doc/en/... and as well to some html files provided by some > spkg. This raise two different but related questions: > > 1 - It seems that Sphinx build environment when building the reference manual > and construction for example are unrelated. I can't manage to have link > working back and forth. For example, I can't manage to have the link > :mod:`sage.combinat.permutation` to work in constructions/groups.rst or to > have :ref:`_chapter-groups` to work from sage/combinat/permutations.py
The way to handle linking across different documents is the intersphinx extension: http://sphinx.pocoo.org/latest/ext/intersphinx.html , but there may be some issue with locally browseable docs and docs that are online if their file layouts are different. > 2 - Suppose that we want to provide an spkg with some included html doc, say > some python doc in html. So the doc would be stored somewhere under $SAGE_ROOT > say starting from $SAGE_ROOT/local/doc/python/index.html what would be the > good way to link it from within sage doc (both .py and .rst files) ? I believe intersphinx can fail gracefully if those don't links don't exist. If you're talking about automatically putting links to that in the main documentation index, then we could make a Sphinx directive to detect those and include them if their locations were standardized. --Mike -- To post to this group, send an email to sage-devel@googlegroups.com To unsubscribe from this group, send an email to sage-devel+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/sage-devel URL: http://www.sagemath.org
