-
-
Notifications
You must be signed in to change notification settings - Fork 189
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
Support sequence of copyright statements #224
Comments
Please provide a reproducible example, per the request in the bug report template. Importantly, which theme are you using? A |
I was using the # Theme used
html_theme = "alabaster"
# Change:
# copyright = f"{datetime.now().year}, the Sphinx developers"
# to
copyright = [
f"{datetime.now().year}, the Sphinx developers",
f"{datetime.now().year}, Jane Doe",
] This will result in the following copyright notice in the footer:
but if you use the the default # Theme used
html_theme = "classic"
copyright = [
f"{datetime.now().year}, the Sphinx developers",
f"{datetime.now().year}, Jane Doe",
]
# Disable html sidebars and theme options
# html_sidebars = {
# "**": [
# "about.html",
# "searchfield.html",
# "navigation.html",
# "relations.html",
# "donate.html",
# ]
# }
# html_theme_options = {
# "description": "A light, configurable Sphinx theme",
# "github_user": "sphinx-doc",
# "github_repo": "alabaster",
# "fixed_sidebar": True,
# "tidelift_url": "https://tidelift.com/subscription/pkg/pypi-alabaster?utm_source=pypi-alabaster&utm_medium=referral&utm_campaign=docs", # noqa
# "github_banner": True,
# } that theme properly separates them. This is because the classic inherits its footer from the Note that this will still look pretty wonky in my opinion because they use line breaks as separators between the copyright notices. Then the rest of the footer just goes on the same line as the last copyright notice:
|
Might I suggest a fix where we separate the copyright notice with pipes "|" instead? The result would look something like this:
I have made a pull request #225 that implements this solution: |
According to the Sphinx documentation, Sphinx supports a sequence of strings for the
copyright
orproject_copyright
configuration values.Right now, if you use a sequence of multiple copyright values:
Expected
This should result in two different copyright notices on two lines:
Actual
Instead, the list is converted to a string and displayed as a single copyright notice:
The
classic
sphinx theme still does this correctly.The text was updated successfully, but these errors were encountered: