Welcome to desitemplate’s documentation!

Introduction

This is the documentation for desitemplate.

Contents

The toctree directive can be used to link to other files in this directory and even display their sections. See the toctree documentation.

desitemplate API

This is used to include docstrings from modules. See the autodoc documentation.

If you’re loading a module here, and don’t see some functions, try adding the :imported-members: option.

desitemplate

This package is a template for other DESI Python packages.

You should use desi_update_version to set the version. This requires the desiutil package.

desitemplate.main

This module contains an example command-line function.

desitemplate.main.main()[source]

Entry-point for command-line scripts.

Returns:

Exit status that will be passed to sys.exit().

Return type:

int

Change Log

2.0.1 (unreleased)

  • No changes yet.

2.0.0 (2023-04-19)

  • Updated package layout with eventual deprecation of setup.py in mind.

1.3.0 (2018-09-11)

  • Update ReadTheDocs configuration to use webhooks (PR #15).

1.2.1 (2017-10-26)

  • Fix team name in LICENSE.rst file.

1.2.0 (2017-05-11)

  • Update Travis test infrastructure and tweak documentation configuration.

1.1.2 (2017-05-10)

  • Update template Module file to reflect new DESI+Anaconda infrastructure.

  • Add boilerplate code to allow individual modules to be tested.

1.1.1 (2016-04-25)

  • Update desiutil version.

  • Increase coverage.

1.1.0 (2015-11-06)

  • Minor tweaks to enable Python 3 support.

  • Use requirements.txt to specify required packages.

  • Simplify Travis CI builds.

1.0.0 (2015-11-03)

  • pip install support.

  • Travis build support.

  • ReadTheDocs support.

  • Coveralls support.

  • Add license.

  • Copy changes from desiutil code.

  • Move C++ code to separate package.

0.4.0 (2015-05-22)

  • Changes to support GitHub migration.

  • Rename to desitemplate.

0.3.2 (2015-01-16)

  • Fix a bad function call.

0.3.1 (2015-01-14)

  • Change how doc directory is compiled.

0.3.0 (2014-10-13)

  • Rename to desiTemplate.

  • More careful version checks and operators.

0.2.5 (2014-06-23)

  • Fix directory location.

0.2.4 (2014-06-23)

  • Fix list of install directories.

0.2.3 (2014-06-23)

  • Delegate compilation to sub-Makefiles.

0.2.2 (2014-06-23)

  • Test for presence of Makefile before attempting a compile.

0.2.1 (2014-06-23)

  • Support more general types of code, including IDL.

0.2.0 (2014-06-10)

  • Add C++/Doxygen support.

0.1.4 (2014-06-10)

  • Standardize from __future__ imports.

0.1.3 (2014-05-02)

  • Restore dependencies to module file.

  • Trunk install support in module file.

  • Update documentation.

0.1.2 (2014-05-01)

  • Fix version error.

0.1.1 (2014-05-01)

  • Fix index.rst file.

0.1.0 (2014-05-01)

  • Initial tag.

Indices and tables