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

DOC: simplify pandas footer #53299

Conversation

AbrhamSayd
Copy link

Description

This pull request addresses issue #51536 by proposing a solution to simplify the pandas theme footer.

The sphinx theme currently requires an extra template to specify the footer content, which limits customization options.
For the moment there seems to be no way to get rid of the template and set everything in the config file,
However, after research and explorationI have found a potential workaround that allows us to define the footer content directly in the conf.py configuration file using the html_context setting.

Proposed Changes

  • Updated conf.py to define the footer content using the html_context setting.
  • Modified the pandas_footer.html template to render the footer content defined in conf.py.

Your feedback and suggestions on this approach are highly appreciated.

@mroeschke mroeschke requested a review from datapythonista May 19, 2023 18:18
@mroeschke mroeschke added Docs Web pandas website labels May 19, 2023
<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.



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.

@datapythonista datapythonista changed the title Doc: simplify pandas footer DOC: simplify pandas footer May 20, 2023
@AbrhamSayd AbrhamSayd marked this pull request as draft June 21, 2023 05:33
@mroeschke
Copy link
Member

Thanks for the pull request, but it appears to have gone stale. If interested in continuing, please merge in the main branch, address any review comments and/or failing tests, and we can reopen.

@mroeschke mroeschke closed this Jul 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Web pandas website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants