Skip to content

Doc simplify footer #61859

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@
.tags
.cache/
.vscode/

*.cursorrules
*.cursor
# Compiled source #
###################
*.a
Expand Down
3 changes: 0 additions & 3 deletions doc/_templates/pandas_footer.html

This file was deleted.

9 changes: 8 additions & 1 deletion doc/source/_static/css/pandas.css
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,12 @@ table {
}

.card, .card img {
background-color: var(--pst-color-background);
background: none !important;
}

/* Footer styling */
.footer-items__start {
flex-direction: row;
align-items: center;
gap: 0.5rem;
}
10 changes: 7 additions & 3 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -163,8 +163,12 @@

# General information about the project.
project = "pandas"
# We have our custom "pandas_footer.html" template, using copyright for the current year
copyright = f"{datetime.now().year},"
# Updated copyright to include sponsor information, removing custom template
copyright = (
f'{datetime.now().year}, pandas via '
'<a href="https://numfocus.org">NumFOCUS, Inc.</a> '
'Hosted by <a href="https://www.ovhcloud.com">OVHcloud</a>.'
)

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -242,7 +246,7 @@

html_theme_options = {
"external_links": [],
"footer_start": ["pandas_footer", "sphinx-version"],
"footer_start": ["copyright", "sphinx-version"],
"github_url": "https://github.com/pandas-dev/pandas",
"analytics": {
"plausible_analytics_domain": "pandas.pydata.org",
Expand Down
8 changes: 8 additions & 0 deletions doc/source/whatsnew/v3.0.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -944,6 +944,14 @@ Other
-
-

.. ---------------------------------------------------------------------------
.. _whatsnew_300.documentation:
Copy link
Member

Choose a reason for hiding this comment

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

a release note for documentation changes is not necessary IMO

Copy link
Member

Choose a reason for hiding this comment

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

@Siryoos you have marked this as resolved?


Documentation changes
~~~~~~~~~~~~~~~~~~~~~

- Simplified pandas theme footer implementation by leveraging built-in templates from pydata-sphinx-theme v0.16 (:issue:`51536`)

.. ---------------------------------------------------------------------------
.. _whatsnew_300.contributors:

Expand Down
Loading