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

Fix typos found by codespell #1261

Merged
merged 1 commit into from
Mar 23, 2023
Merged
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
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@
# -- favicon options ---------------------------------------------------------

# see https://sphinx-favicon.readthedocs.io for more information about the
# sphinx-favicon extention
# sphinx-favicon extension
favicons = [
# generic icons compatible with most browsers
"favicon-32x32.png",
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/analytics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Analytics and usage services
============================

The theme supports several web analytics services via the ``analytics`` option. It is configured
by passing a dictionary with options. See the sections bellow for relevant
by passing a dictionary with options. See the sections below for relevant
options depending on the analytics provider that you want to use.

.. code:: python
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/light-dark.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Customize the CSS of light and dark themes

.. danger::

Theming is still a beta feature so the variables related to color theming are likely to change in the future. No backward compatibily is guaranteed when customization is done.
Theming is still a beta feature so the variables related to color theming are likely to change in the future. No backward compatibility is guaranteed when customization is done.


To customize the CSS of page elements in a theme-dependent manner, use the ``html[data-theme='<THEME>']`` CSS selector.
Expand Down
4 changes: 2 additions & 2 deletions src/pydata_sphinx_theme/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ def update_config(app):
if theme_options.get("favicons"):
logger.warning(
"The configuration `favicons` is deprecated."
"Use the sphinx-favicon extention instead."
"Use the sphinx-favicon extension instead."
)

# Validate icon links
Expand Down Expand Up @@ -446,7 +446,7 @@ def generate_header_nav_html(n_links_before_dropdown=5):

return out

# Cache this function because it is expensive to run, and becaues Sphinx
# Cache this function because it is expensive to run, and because Sphinx
# somehow runs this twice in some circumstances in unpredictable ways.
@lru_cache(maxsize=None)
def generate_toctree_html(kind, startdepth=1, show_nav_level=1, **kwargs):
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// the icons for theme change
.theme-switch-button {
// overide bootstrap settings
// override bootstrap settings
border-color: var(--pst-color-on-background);
// Size is a bit smaller because the background shadow is bigger
font-size: calc(var(--pst-font-size-icon) - 0.1rem);
Expand All @@ -20,7 +20,7 @@

&:hover,
&:active {
// overide bootstrap settings
// override bootstrap settings
background-color: var(--pst-color-on-surface) !important;
border-color: var(--pst-color-on-background) !important;
a {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ nav.page-toc {
display: block;
padding: 0.125rem 0;

// Padding w/ negative margin so the top TOC item highligh overlaps w/ the TOC border
// Padding w/ negative margin so the top TOC item highlight overlaps w/ the TOC border
padding-left: 1rem;
margin-left: -1rem;
color: var(--pst-color-text-muted);
Expand Down
2 changes: 1 addition & 1 deletion tests/test_build.py
Original file line number Diff line number Diff line change
Expand Up @@ -881,7 +881,7 @@ def test_empty_templates(sphinx_build_factory):
sphinx_build = sphinx_build_factory("base", confoverrides=confoverrides).build()
html = sphinx_build.html_tree("page1.html")

# We've set this to fase in the config so the template shouldn't show up at all
# We've set this to false in the config so the template shouldn't show up at all
assert not html.select(".tocsection.sourcelink")

# Should not be any icon link wrapper because none are given in conf
Expand Down
2 changes: 1 addition & 1 deletion webpack.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ const fa_fonts = [
/*******************************************************************************
* Cache-busting Jinja2 macros (`webpack-macros.html`) used in `layout.html`
*
* @param {Compilation} the compilation instace to extract the hash
* @param {Compilation} the compilation instance to extract the hash
* @return {String} the macro to inject in layout.html
*/
function macroTemplate({ compilation }) {
Expand Down