desihub / desitemplate Goto Github PK

I noticed desispec has a sphinx Makefile and conf.py, but not described in the template. Are there standard protocols to set up the sphinx documentation?

The template should contain some simple example tests.

desitemplate nominally depends on desiutil, so that package needs to be installed before any tests begin.

The template product should contain an example license file.

Every few months we chase our tails trying to figure out a Travis test environment problem that is caused by updates to Travis, conda packages, or pip packages. This is usually completely unrelated to the PR that triggered the problem, and feels like a huge waste of time. desihub/desitarget#416 is a recent example.

Reconsider how we configure the travis environment for desi testing. A few options:

• live with the current method and play whack-a-mole when needed.
• switch to virtualenv+pip and don't use conda for travis tests. @tskisner has had luck with this method on other projects.
• generate a docker container with our external dependencies pre-installed (preferably coordinated with desiconda). Always grab the same known docker image and then install desiutil/desispec/desisim/desitarget etc. into that image before testing. This would provide us with the most external package stability, while requiring more maintenance to support different versions of python, numpy, astropy, etc.
• other?

desiutil is currently contains the most cutting-edge testing infrastructure (Python 3.6, minimal install requirements, optional tests, etc.). Update desitemplate to reflect this.

It may be simpler to support DESI template products if there are two separate templates, one for pure Python/Cython packages, and one for pure C/C++ packages.

desitemplate needs a changes file, similar to the one in desiutil.

desitemplate has outdated instructions for setting the __version__ string.

A few boilerplate files that were previously provided by desiInstall need to be restored in order to support things like Travis builds and ReadTheDocs. These include things like:

• doc/Makefile
• doc/conf.py