-
Notifications
You must be signed in to change notification settings - Fork 3.5k
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
GH-39504: [Docs] Update footer in main sphinx docs with correct attribution #39505
Conversation
jorisvandenbossche
commented
Jan 8, 2024
•
edited by github-actions
bot
Loading
edited by github-actions
bot
- Closes: [Docs] Update footer in main sphinx docs #39504
|
@github-actions crossbow submit preview-docs |
Revision: 781a79a Submitted crossbow builds: ursacomputing/crossbow @ actions-55649db991
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @jorisvandenbossche
@@ -201,7 +201,12 @@ | |||
|
|||
# General information about the project. | |||
project = u'Apache Arrow' | |||
copyright = f'2016-{datetime.datetime.now().year} Apache Software Foundation' | |||
copyright = ( | |||
f"2016-{datetime.datetime.now().year} Apache Software Foundation.\n" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
\n
doesn't add a newline. We could try multiline copyright text with comma separated items: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-copyright like:
copyright = (
f"2016-{datetime.datetime.now().year} Apache Software Foundation.",
"Apache Arrow, Arrow, Apache, the Apache feather logo, and the Apache Arrow project logo are either registered",
"trademarks or trademarks of The Apache Software Foundation in the United States and other countries"
)
but would need to use newer version of Sphinx (7.0.1, sphinx-doc/sphinx#10983). I think we should unpin Sphinx anyways.
Breaking the copyright text into multiple lines would also make it smaller in width and so the text on the right (PyData SphinxTheme text) could be kept all in one line. See http://crossbow.voltrondata.com/pr_docs/39505/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point .. the \n
indeed doesn't do anything.
Updating sphinx is indeed something we should do, but from looking at that PR, the multiline copyright might not be exactly what we want here, because from the test added in that PR, it seems that it adds the © Copyright
to each line then, which we don't want (https://github.com/sphinx-doc/sphinx/pull/10983/files#diff-da24b355349b53e4c8047034767d008e4c2ce9ea6c8933a3acd50d0828f00528)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a bit annoying that the layout is not looking good with this long copyright text, but I am afraid that this is only something that can be fixed in the theme (or we could override the footer block in our layout).
Also on mobile it doesn't look good, but that's again an issue with the upstream theme as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh you are correct. Having © Copyright
on each line sure isn't what we want.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, there is not much we can do about it really.
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Yes, will merge 👍 |
After merging your PR, Conbench analyzed the 4 benchmarking runs that have been run so far on merge-commit 7acbaf4. There were no benchmark performance regressions. 🎉 The full Conbench report has more details. |
… attribution (apache#39505) * Closes: apache#39504 Lead-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
… attribution (apache#39505) * Closes: apache#39504 Lead-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
… attribution (apache#39505) * Closes: apache#39504 Lead-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
… attribution (apache#39505) * Closes: apache#39504 Lead-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
… attribution (apache#39505) * Closes: apache#39504 Lead-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>