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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jan 15, 2024
Merged

GH-39504: [Docs] Update footer in main sphinx docs with correct attribution #39505

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
781a79a
GH-39504: [Docs] Update footer in main sphinx docs with correct attri…
jorisvandenbossche Jan 8, 2024
cc518fe
Update docs/source/conf.py
jorisvandenbossche Jan 10, 2024
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
7 changes: 6 additions & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Copy link
Member

@AlenkaF AlenkaF Jan 8, 2024 •
edited
Loading

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/

Copy link
Member Author

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)

Copy link
Member Author

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.

Copy link
Member

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.

Copy link
Member

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.

"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"
)
author = u'Apache Software Foundation'

# The version info for the project you're documenting, acts as replacement for
Expand Down