From da4e8acc899efe89411e7927e6df769d7d149f16 Mon Sep 17 00:00:00 2001 From: Oliver Beckstein Date: Sat, 27 Jul 2024 23:44:26 -0700 Subject: [PATCH 1/3] replace doc footer - fix #383 - replaced explicit (incomplete) author list in doc footer with The alchemlyb development team and a link to AUTHORS - automatically insert the current year into copyright - Needed to hack the RTD theme to avoid the URL escape on the copyright variable by including a _templates/footer.html template. --- docs/.templates/footer.html | 32 ++++++++++++++++++++++++++++++++ docs/conf.py | 13 ++++++------- 2 files changed, 38 insertions(+), 7 deletions(-) create mode 100644 docs/.templates/footer.html diff --git a/docs/.templates/footer.html b/docs/.templates/footer.html new file mode 100644 index 00000000..8503b5ea --- /dev/null +++ b/docs/.templates/footer.html @@ -0,0 +1,32 @@ +{% extends "!footer.html" %} +{% block contentinfo %} +

+ {%- if show_copyright %} + {%- if hasdoc('copyright') %} + {%- trans path=pathto('copyright'), copyright=copyright %}© Copyright {{ copyright }}.{% endtrans %} + {%- else %} + {%- trans copyright=copyright %}© Copyright {{ copyright }}.{% endtrans %} + {%- endif %} + {%- endif %} + + {%- if build_id and build_url %} + + {#- Translators: Build is a noun, not a verb -#} + {%- trans %}Build{% endtrans -%} + {{ build_id }}. + + {%- elif commit %} + + {#- Translators: the phrase "revision" comes from Git, referring to a commit #} + {%- trans %}Revision{% endtrans %} {{ commit }}. + + {%- endif %} + {%- if last_updated %} + + {%- trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %} + + {%- endif -%} + +

+ +{% endblock %} diff --git a/docs/conf.py b/docs/conf.py index a2e7ae3e..5d78c185 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,6 +20,7 @@ # import sys # sys.path.insert(0, os.path.abspath('.')) +import datetime # -- General configuration ------------------------------------------------ @@ -39,7 +40,7 @@ ] # Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] +templates_path = [".templates"] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: @@ -51,12 +52,10 @@ master_doc = "index" # General information about the project. +now = datetime.datetime.now() project = "alchemlyb" -author = """Irfan Alibay, Bryce Allen, Mohammad S. Barhaghi, Oliver -Beckstein, David Dotson, Jérôme Hénin, Travis Jensen, Thomas -T. Joseph, Ian Kenney, Hyungro Lee, Victoria Lim, Shuai Liu, Domenico -Marson, Pascal Merz, Alexander Schlaich, Dominik Wille, Zhiyi Wu""" -copyright = "2017-2022, " + author +author = 'The alchemlyb development team (see AUTHORS)' +copyright = f"2017-{now.year}, " + author # The version info for the project you're documenting, acts as replacement for @@ -176,7 +175,7 @@ # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { - "https://docs.python.org/": None, + "python": ("https://docs.python.org/", None), "pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None), "pymbar": ("https://pymbar.readthedocs.io/en/latest/", None), "alchemtest": ("https://alchemtest.readthedocs.io/en/latest/", None), From 941d8ae871b50266f555e53e5d8843a8fa9a44b4 Mon Sep 17 00:00:00 2001 From: Oliver Beckstein Date: Sat, 27 Jul 2024 23:47:24 -0700 Subject: [PATCH 2/3] update AUTHORS header with maintainers The AUTHORS file should show at the top that @xiki-tempula is playing an important role for alchemlyb, in line with the acknowledgements section of the JOSS paper. --- AUTHORS | 3 +++ 1 file changed, 3 insertions(+) diff --git a/AUTHORS b/AUTHORS index 19ee3a57..1d6ee905 100644 --- a/AUTHORS +++ b/AUTHORS @@ -8,6 +8,9 @@ The alchemlyb project is led by Oliver Beckstein (@orbeckst), David Mobley (@davidlmobley), and Michal Shirts (@mrshirts). alchemlyb was originally created by David Dotson (@dotsdl). +The project is being maintained by Zhiyi Wu (@xiki-tempula) and Oliver +Beckstein (@orbeckst). + All contributing authors are listed in this file below. Full name and GitHub handle are preferred. The repository history at https://github.com/alchemistry/alchemlyb and the CHANGES file show From a768d1f7f85ab2b36b5994d430afa4dfcaaeca5c Mon Sep 17 00:00:00 2001 From: Oliver Beckstein Date: Sat, 27 Jul 2024 23:48:19 -0700 Subject: [PATCH 3/3] inserted a cosmetic blank line into AUTHORS --- AUTHORS | 1 + 1 file changed, 1 insertion(+) diff --git a/AUTHORS b/AUTHORS index 1d6ee905..80df4495 100644 --- a/AUTHORS +++ b/AUTHORS @@ -50,5 +50,6 @@ Chronological list of authors - Irfan Alibay (@IAlibay) - Pascal Merz (@ptmerz) - Domenico Marson (@DrDomenicoMarson) + 2023 - Haoxi Li (@hl2500)