Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update citation information (Fixes #1154) #1157

Merged
merged 1 commit into from Sep 11, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 13 additions & 8 deletions docs/citing.rst
Expand Up @@ -12,14 +12,17 @@ DOI: `10.5065/D6WW7G29 <https://doi.org/10.5065/D6WW7G29>`_
BibTeX entry
************

Example BibTeX entry::
Example BibTeX entry:

.. parsed-literal::

@software{metpy,
author = {May, Ryan and Arms, Sean and Marsh, Patrick and Bruning, Eric and Leeman, John },
author = {May, Ryan M. and Arms, Sean C. and Marsh, Patrick and Bruning, Eric and Leeman, John R.
and Goebbert, Kevin and Thielen, Jonathan E. and Bruck, Zachary},
organization = {Unidata},
title = {MetPy: A {Python} Package for Meteorological Data},
year = {2008 - 2017},
version = {0.4.3},
year = {2008 - |cite_year|},
version = {|cite_version|},
doi = {10.5065/D6WW7G29},
url = {https://github.com/Unidata/MetPy},
address = {Boulder, Colorado}
Expand All @@ -30,10 +33,12 @@ Example BibTeX entry::
AMS Journal Style
*****************

Example Citation::
Example Citation:

.. parsed-literal::

May, R. M., Arms, S. C., Marsh, P., Bruning, E. and Leeman, J. R., 2017:
MetPy: A Python Package for Meteorological Data.
Unidata, Accessed 31 March 2017.
May, R. M., Arms, S. C., Marsh, P., Bruning, E., Leeman, J. R., Goebbert, K., Thielen, J. E.,
and Bruick, Z., |cite_year|: MetPy: A Python Package for Meteorological Data.
Version |cite_version|, Unidata, Accessed |access_date|.
[Available online at https://github.com/Unidata/MetPy.]
doi:10.5065/D6WW7G29.
12 changes: 10 additions & 2 deletions docs/conf.py
Expand Up @@ -10,8 +10,9 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys
from datetime import datetime
import os
import sys

import metpy

Expand Down Expand Up @@ -99,10 +100,17 @@
#
# The short X.Y version.
verinfo = metpy.__version__
version = verinfo.split('+')[0].rsplit('.', 1)[0]
full_version = verinfo.split('+')[0]
version = full_version.rsplit('.', 1)[0]
# The full version, including alpha/beta/rc tags.
release = verinfo

rst_prolog = '''
.. |cite_version| replace:: {0}
.. |cite_year| replace:: {1:%Y}
.. |access_date| replace:: {1:%d %B %Y}
'''.format(full_version, datetime.utcnow())

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
Expand Down