Dear sage-devel,

The spkg-install [1] (inspired from a early version of sagemanifolds) of my 
optional sage package slabbe-0.2.spkg installs the documentation like this:

# Remove old documentation
rm -fr "$SAGE_ROOT"/src/sage/doc/en/slabbe*
cp -r doc/en/slabbe "$SAGE_ROOT"/src/doc/en


[1] https://github.com/seblabbe/slabbe/blob/master/spkg-install


This allows me (or use to allow me, because I don't know now if sage 
-docbuild works the same way as before) to build the documentation of my 
optional package by doing simply:

    sage -docbuild slabbe inventory
    sage -docbuild slabbe html 
    sage -docbuild slabbe pdf

But then git status tells me about "Untracked files" in 
src/sage/doc/en/slabbe which I finds not so clean. And these files breaks 
the sage doc builds.

Now sagemanifolds propose a script sm-install.sh that alters the 
documentation files of Sage. Maybe this is how they fix the problem with 
sage documentation building with the sagemanifolds doc somewhere in the 
tree.

"""
# Altering src/sage/all.py for import
if [[ -z $(grep "sage.manifolds.all" src/sage/all.py) ]]; then
   echo "$(tput setaf 4)Adding manifolds import to all.py...$(tput sgr 0)"
   echo "from sage.manifolds.all import *" >> src/sage/all.py
fi

# Altering src/doc/en/reference/index.rst for documentation
# using either sed (linux) or gsed (MacOS X)
...
"""

But then git status tells me about dozens of files that are modified or 
added. I believe it is not so clean.

My question are:

- How should the documentation of an optional Sage package be installed in 
Sage?
- Is there a way so that the git tree is clean after the installation?

Sébastien

-- 
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