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

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

Merged
merged 2 commits into from
Jan 15, 2024

Conversation

jorisvandenbossche
Copy link
Member

@jorisvandenbossche jorisvandenbossche commented Jan 8, 2024

Copy link

github-actions bot commented Jan 8, 2024

⚠️ GitHub issue #39504 has no components, please add labels for components.

@AlenkaF
Copy link
Member

AlenkaF commented Jan 8, 2024

@github-actions crossbow submit preview-docs

Copy link

github-actions bot commented Jan 8, 2024

Revision: 781a79a

Submitted crossbow builds: ursacomputing/crossbow @ actions-55649db991

Task Status
preview-docs GitHub Actions

Copy link
Member

@andygrove andygrove left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docs/source/conf.py Outdated Show resolved Hide resolved
@@ -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

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.

Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
@github-actions github-actions bot added awaiting changes Awaiting changes and removed awaiting committer review Awaiting committer review labels Jan 10, 2024
@raulcd
Copy link
Member

raulcd commented Jan 15, 2024

Should we merge this?
image

@AlenkaF
Copy link
Member

AlenkaF commented Jan 15, 2024

Yes, will merge 👍

@AlenkaF AlenkaF merged commit 7acbaf4 into apache:main Jan 15, 2024
11 checks passed
@AlenkaF AlenkaF removed the awaiting changes Awaiting changes label Jan 15, 2024
Copy link

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.

@jorisvandenbossche jorisvandenbossche deleted the gh-39504-footer branch January 18, 2024 08:42
idailylife pushed a commit to idailylife/arrow that referenced this pull request Jan 18, 2024
… 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>
clayburn pushed a commit to clayburn/arrow that referenced this pull request Jan 23, 2024
… 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>
dgreiss pushed a commit to dgreiss/arrow that referenced this pull request Feb 19, 2024
… 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>
raulcd pushed a commit that referenced this pull request Feb 20, 2024
…bution (#39505)

* Closes: #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>
zanmato1984 pushed a commit to zanmato1984/arrow that referenced this pull request Feb 28, 2024
… 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>
thisisnic pushed a commit to thisisnic/arrow that referenced this pull request Mar 8, 2024
… 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Update footer in main sphinx docs
4 participants