Opened 9 years ago

Last modified 8 years ago

## #10823 closed enhancement

# environment variable SAGE_SPKG_INSTALL_DOCS to build and install spkg docs — at Initial Version

Reported by: | jason | Owned by: | tbd |
---|---|---|---|

Priority: | major | Milestone: | sage-4.7 |

Component: | packages: standard | Keywords: | |

Cc: | drkirkby, kcrisman | Merged in: | |

Authors: | Reviewers: | ||

Report Upstream: | N/A | Work issues: | |

Branch: | Commit: | ||

Dependencies: | Stopgaps: |

### Description

There are lots of times when it would be convenient to have the documentation of various spkgs installed in a local or system Sage installation. For example, it seems that I'm always wishing that I had that at an airport or on an airplane. At one point a long time ago, we had an extradocs spkg, but it was never maintained. So here is a proposal:

When building an spkg, if the SAGE_SPKG_INSTALL_DOCS environment variable is yes, then the docs are built (if available in the spkg) and are installed in $SAGE_ROOT/local/share/doc/<SPKG NAME>/

For example, numpy includes the docs with the sources. I'd like to insert the following at the bottom of the numpy spkg-install:

if [ "x$SAGE_SPKG_INSTALL_DOCS" = xyes ] ; then cd doc make html if [ $? -ne 0 ]; then echo "Error building numpy." exit 1 fi mkdir -p $SAGE_ROOT/local/share/doc/numpy cp -r build/html $SAGE_ROOT/local/share/doc/numpy fi

This builds the numpy docs and makes a directory $SAGE_ROOT/local/share/doc/numpy/html/ that contains the standalone html documentation for numpy.

**Note:**See TracTickets for help on using tickets.