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

replace doc footer #384

Merged
merged 3 commits into from
Jul 28, 2024
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -47,5 +50,6 @@ Chronological list of authors
- Irfan Alibay (@IAlibay)
- Pascal Merz (@ptmerz)
- Domenico Marson (@DrDomenicoMarson)

2023
- Haoxi Li (@hl2500)
32 changes: 32 additions & 0 deletions docs/.templates/footer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{% extends "!footer.html" %}
{% block contentinfo %}
<p>
{%- if show_copyright %}
{%- if hasdoc('copyright') %}
{%- trans path=pathto('copyright'), copyright=copyright %}&#169; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
{%- else %}
{%- trans copyright=copyright %}&#169; Copyright {{ copyright }}.{% endtrans %}
{%- endif %}
{%- endif %}

{%- if build_id and build_url %}
<span class="build">
{#- Translators: Build is a noun, not a verb -#}
{%- trans %}Build{% endtrans -%}
<a href="{{ build_url }}">{{ build_id }}</a>.
</span>
{%- elif commit %}
<span class="commit">
{#- Translators: the phrase "revision" comes from Git, referring to a commit #}
{%- trans %}Revision{% endtrans %} <code>{{ commit }}</code>.
</span>
{%- endif %}
{%- if last_updated %}
<span class="lastupdated">
{%- trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
</span>
{%- endif -%}

</p>

{% endblock %}
13 changes: 6 additions & 7 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
# import sys
# sys.path.insert(0, os.path.abspath('.'))

import datetime

# -- General configuration ------------------------------------------------

Expand All @@ -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:
Expand All @@ -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 <a href="https://raw.githubusercontent.com/alchemistry/alchemlyb/master/AUTHORS">AUTHORS</a>)'
copyright = f"2017-{now.year}, " + author


# The version info for the project you're documenting, acts as replacement for
Expand Down Expand Up @@ -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),
Expand Down
Loading