On Tue, Jan 29, 2019 at 8:40 AM Jeroen Demeyer <j.deme...@ugent.be> wrote:
>
> On 2019-01-29 09:32, Vincent Delecroix wrote:
> > 1) When a user performs `sage -pip install X`, should the documentation
> >      be compiled and installed?
>
> I'm pretty sure that the answer is "no" for most Python packages. I see
> two reasons for this:
>
> - there is no easy and obvious way to integrate this in setup.py
> - it adds extra dependencies (on Sphinx for example) unrelated to the
> actual functionality of the package
>
If the package at hand is a Sage component with Sphinx docs available,
they ought to be installed in SAGE_SHARE/doc/
(and linked to the main docs using intersphinx or something like that
- something we must work on to fix, I think)

We now have there e.g. sagenb and sagetex, I don't know what happened
to cysignals and cypari docs, it seems
that this should be fixed, and docs for them installed locally (and linked)

Without this done, also doc.sagemath.org gets filled with broken
links, another important reason to have this all there
and aligned.

-- 
You received this message because you are subscribed to the Google Groups 
"sage-devel" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sage-devel+unsubscr...@googlegroups.com.
To post to this group, send email to sage-devel@googlegroups.com.
Visit this group at https://groups.google.com/group/sage-devel.
For more options, visit https://groups.google.com/d/optout.

Reply via email to