From ab52404626950d257ba1356da39bb4a4a12fd949 Mon Sep 17 00:00:00 2001 From: Kian-Meng Ang Date: Thu, 24 Mar 2022 23:39:03 +0800 Subject: [PATCH] Fix typos --- README.md | 2 +- docs/demo/example_pandas.rst | 2 +- docs/user_guide/sections.rst | 2 +- src/pydata_sphinx_theme/__init__.py | 2 +- tests/test_build.py | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f2940f165..f197ba3ea 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ more detail in the contributing section of the documentation: ### The html layout -The "layout" included in this theme is originally mainly targetted towards +The "layout" included in this theme is originally mainly targeted towards documentation sites with many pages, and where putting all navigation in a single sidebar can therefore get unwieldy. diff --git a/docs/demo/example_pandas.rst b/docs/demo/example_pandas.rst index a25a41022..8c6b2c40e 100644 --- a/docs/demo/example_pandas.rst +++ b/docs/demo/example_pandas.rst @@ -1188,5 +1188,5 @@ This will **not** work at all, and so should be avoided: .. meta:: :description lang=en: - An example of a long HTML page, as is comming in the pandas documentation + An example of a long HTML page, as is coming in the pandas documentation in pydata-sphinx-theme. diff --git a/docs/user_guide/sections.rst b/docs/user_guide/sections.rst index 403fd77c2..6042b32a4 100644 --- a/docs/user_guide/sections.rst +++ b/docs/user_guide/sections.rst @@ -121,7 +121,7 @@ By default, it has the following templates: A list of built-in templates you can insert into sections ========================================================= -Below is a list of build-in templates that you can insert into any section. +Below is a list of built-in templates that you can insert into any section. Note that some of them may have CSS rules that assume a specific section (and will be named accordingly). diff --git a/src/pydata_sphinx_theme/__init__.py b/src/pydata_sphinx_theme/__init__.py index f3473111d..882896495 100644 --- a/src/pydata_sphinx_theme/__init__.py +++ b/src/pydata_sphinx_theme/__init__.py @@ -407,7 +407,7 @@ def index_toctree(app, pagename: str, startdepth: int, collapse: bool = True, ** except IndexError: # eg for index.rst, but also special pages such as genindex, py-modindex, search # those pages don't have a "current" element in the toctree, so we can - # directly return an emtpy string instead of using the default sphinx + # directly return an empty string instead of using the default sphinx # toctree.get_toctree_for(pagename, app.builder, collapse, **kwargs) return "" diff --git a/tests/test_build.py b/tests/test_build.py index c5f1ac815..1b6088bdb 100644 --- a/tests/test_build.py +++ b/tests/test_build.py @@ -336,7 +336,7 @@ def test_included_toc(sphinx_build_factory): # html contexts for `show_edit_button` -# these are "good" context fragements that should yield a working link +# these are "good" context fragments that should yield a working link good_edits = [ [ {