diff --git a/doc/api.rst b/doc/api.rst index 3a8679ca2..99a0f1292 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -168,14 +168,6 @@ Top-level functions Submodules ========== -signac.cite module ------------------- - -.. automodule:: signac.cite - :members: - :undoc-members: - :show-inheritance: - signac.sync module ------------------ diff --git a/signac/__init__.py b/signac/__init__.py index 5d475ec49..dd5844526 100644 --- a/signac/__init__.py +++ b/signac/__init__.py @@ -9,7 +9,7 @@ collectively accessible. """ -from . import cite, contrib, errors, sync, testing, warnings +from . import contrib, errors, sync, testing, warnings from .contrib import ( Collection, Project, @@ -38,7 +38,6 @@ "errors", "warnings", "sync", - "cite", "Project", "TemporaryProject", "get_project", diff --git a/signac/cite.py b/signac/cite.py deleted file mode 100644 index dbb8d3aa7..000000000 --- a/signac/cite.py +++ /dev/null @@ -1,84 +0,0 @@ -# Copyright (c) 2017 The Regents of the University of Michigan -# All rights reserved. -# This software is licensed under the BSD 3-Clause License. -"""Functions to support citing this software.""" -import sys - -from deprecation import deprecated - -from .version import __version__ - -ARXIV_BIBTEX = """@online{signac, - author = {Carl S. Adorf and Paul M. Dodd and Sharon C. Glotzer}, - title = {signac - A Simple Data Management Framework}, - year = {2016}, - eprinttype = {arxiv}, - eprintclass = {cs.DB}, - eprint = {1611.03543} -} -""" - - -ARXIV_REFERENCE = ( - "Carl S. Adorf, Paul M. Dodd, and Sharon C. Glotzer. " - "signac - A Simple Data Management Framework. 2016. " - "arXiv:1611.03543 [cs.DB]" -) - - -@deprecated( - deprecated_in="1.8", - removed_in="2.0", - current_version=__version__, - details="The cite module is deprecated.", -) -def bibtex(file=None): - """Generate bibtex entries for signac. - - The bibtex entries will be printed to screen unless a - filename or a file-like object are provided, in which - case they will be written to the corresponding file. - - .. note:: - - A full reference should also include the - version of this software. Please refer to the - documentation on how to cite a specific version. - - :param file: A str or file-like object. - Defaults to sys.stdout. - """ - if file is None: - file = sys.stdout - elif isinstance(file, str): - file = open(file, "w") - file.write(ARXIV_BIBTEX) - - -@deprecated( - deprecated_in="1.8", - removed_in="2.0", - current_version=__version__, - details="The cite module is deprecated.", -) -def reference(file=None): - """Generate formatted reference entries for signac. - - The references will be printed to screen unless a - filename or a file-like object are provided, in which - case they will be written to the corresponding file. - - .. note:: - - A full reference should also include the - version of this software. Please refer to the - documentation on how to cite a specific version. - - :param file: A str or file-like object. - Defaults to sys.stdout. - """ - if file is None: - file = sys.stdout - elif isinstance(file, str): - file = open(file, "w") - file.write(ARXIV_REFERENCE + "\n")