Skip to content

Commit 911ce53

Browse files
authored
Merge pull request #384 from alchemistry/update-doc-footer
replace doc footer
2 parents 124f148 + a768d1f commit 911ce53

File tree

3 files changed

+42
-7
lines changed

3 files changed

+42
-7
lines changed

AUTHORS

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ The alchemlyb project is led by Oliver Beckstein (@orbeckst), David
88
Mobley (@davidlmobley), and Michal Shirts (@mrshirts). alchemlyb was
99
originally created by David Dotson (@dotsdl).
1010

11+
The project is being maintained by Zhiyi Wu (@xiki-tempula) and Oliver
12+
Beckstein (@orbeckst).
13+
1114
All contributing authors are listed in this file below. Full name and
1215
GitHub handle are preferred. The repository history at
1316
https://github.com/alchemistry/alchemlyb and the CHANGES file show
@@ -47,5 +50,6 @@ Chronological list of authors
4750
- Irfan Alibay (@IAlibay)
4851
- Pascal Merz (@ptmerz)
4952
- Domenico Marson (@DrDomenicoMarson)
53+
5054
2023
5155
- Haoxi Li (@hl2500)

docs/.templates/footer.html

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
{% extends "!footer.html" %}
2+
{% block contentinfo %}
3+
<p>
4+
{%- if show_copyright %}
5+
{%- if hasdoc('copyright') %}
6+
{%- trans path=pathto('copyright'), copyright=copyright %}&#169; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
7+
{%- else %}
8+
{%- trans copyright=copyright %}&#169; Copyright {{ copyright }}.{% endtrans %}
9+
{%- endif %}
10+
{%- endif %}
11+
12+
{%- if build_id and build_url %}
13+
<span class="build">
14+
{#- Translators: Build is a noun, not a verb -#}
15+
{%- trans %}Build{% endtrans -%}
16+
<a href="{{ build_url }}">{{ build_id }}</a>.
17+
</span>
18+
{%- elif commit %}
19+
<span class="commit">
20+
{#- Translators: the phrase "revision" comes from Git, referring to a commit #}
21+
{%- trans %}Revision{% endtrans %} <code>{{ commit }}</code>.
22+
</span>
23+
{%- endif %}
24+
{%- if last_updated %}
25+
<span class="lastupdated">
26+
{%- trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
27+
</span>
28+
{%- endif -%}
29+
30+
</p>
31+
32+
{% endblock %}

docs/conf.py

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
# import sys
2121
# sys.path.insert(0, os.path.abspath('.'))
2222

23+
import datetime
2324

2425
# -- General configuration ------------------------------------------------
2526

@@ -39,7 +40,7 @@
3940
]
4041

4142
# Add any paths that contain templates here, relative to this directory.
42-
templates_path = ["_templates"]
43+
templates_path = [".templates"]
4344

4445
# The suffix(es) of source filenames.
4546
# You can specify multiple suffix as a list of string:
@@ -51,12 +52,10 @@
5152
master_doc = "index"
5253

5354
# General information about the project.
55+
now = datetime.datetime.now()
5456
project = "alchemlyb"
55-
author = """Irfan Alibay, Bryce Allen, Mohammad S. Barhaghi, Oliver
56-
Beckstein, David Dotson, Jérôme Hénin, Travis Jensen, Thomas
57-
T. Joseph, Ian Kenney, Hyungro Lee, Victoria Lim, Shuai Liu, Domenico
58-
Marson, Pascal Merz, Alexander Schlaich, Dominik Wille, Zhiyi Wu"""
59-
copyright = "2017-2022, " + author
57+
author = 'The alchemlyb development team (see <a href="https://raw.githubusercontent.com/alchemistry/alchemlyb/master/AUTHORS">AUTHORS</a>)'
58+
copyright = f"2017-{now.year}, " + author
6059

6160

6261
# The version info for the project you're documenting, acts as replacement for
@@ -176,7 +175,7 @@
176175

177176
# Example configuration for intersphinx: refer to the Python standard library.
178177
intersphinx_mapping = {
179-
"https://docs.python.org/": None,
178+
"python": ("https://docs.python.org/", None),
180179
"pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None),
181180
"pymbar": ("https://pymbar.readthedocs.io/en/latest/", None),
182181
"alchemtest": ("https://alchemtest.readthedocs.io/en/latest/", None),

0 commit comments

Comments
 (0)