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

DOC: simplify pandas footer #53299

Closed
wants to merge 2 commits into from
Closed

DOC: simplify pandas footer #53299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d55d43
DOC: Simplify pandas theme footer (#51536)
AbrhamSayd May 19, 2023
1d319bd
moved all content from pandas_footer.html to conf.py
reyes256 May 19, 2023
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: 1 addition & 3 deletions doc/_templates/pandas_footer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
<p class="copyright">
&copy {{copyright}} pandas via <a href="https://numfocus.org">NumFOCUS, Inc.</a> Hosted by <a href="https://www.ovhcloud.com">OVHcloud</a>.
</p>
{{footer}}
Copy link
Member

Choose a reason for hiding this comment

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

The idea of the issue is to remove this file.

5 changes: 5 additions & 0 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,11 +375,16 @@
import os
os.chdir(r'{os.path.dirname(os.path.dirname(__file__))}')
"""
footer = f"""<p class="copyright">
&copy{datetime.now().year}
pandas via <a href="https://numfocus.org">NumFOCUS, Inc.</a>
Hosted by <a href="https://www.ovhcloud.com">OVHcloud</a>.</p>"""


html_context = {
"redirects": dict(moved_api_pages),
"header": header,
"footer": footer
Copy link
Member

Choose a reason for hiding this comment

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

What you want is to edit html_theme_options, and specify the footer html there. My understanding is that in older pydata sphinx theme versions we could only append to the predefined footer, and now we can fully overwrite it. That's what we want to do, to have the same exact footer as now, without having to have our custom footer template.

Copy link
Author

Choose a reason for hiding this comment

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

I've been looking for a solution to this, I'm still working on it.

}

# If false, no module index is generated.
Expand Down