From 460a63010fbe5fcf3ada4d5871125bd52934c164 Mon Sep 17 00:00:00 2001 From: Dimitri Papadopoulos Orfanos <3234522+DimitriPapadopoulos@users.noreply.github.com> Date: Thu, 4 Jan 2024 03:37:44 +0100 Subject: [PATCH] Fix various spelling errors (#11735) --- doc/index.rst | 2 +- doc/latex.rst | 2 +- doc/usage/domains/python.rst | 4 ++-- doc/usage/extensions/coverage.rst | 4 ++-- doc/usage/quickstart.rst | 2 +- doc/usage/restructuredtext/roles.rst | 2 +- sphinx/domains/cpp.py | 4 ++-- sphinx/environment/__init__.py | 2 +- sphinx/ext/autosummary/__init__.py | 2 +- sphinx/registry.py | 2 +- sphinx/texinputs/sphinxlatextables.sty | 2 +- sphinx/themes/agogo/layout.html | 2 +- tests/roots/test-versioning/insert_beginning.txt | 2 +- tests/test_ext_autosectionlabel.py | 2 +- 14 files changed, 17 insertions(+), 17 deletions(-) diff --git a/doc/index.rst b/doc/index.rst index e9aea1c60..6dfdb6d94 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -21,7 +21,7 @@ Here are some of Sphinx's major features: `, and much more functionality via :ref:`third-party extensions `. * **Themes:** modify the look and feel of outputs via :doc:`creating themes - `, and re-use many :ref:`third-party themes + `, and reuse many :ref:`third-party themes `. * **Contributed extensions:** dozens of extensions :ref:`contributed by users `; most of them installable from PyPI. diff --git a/doc/latex.rst b/doc/latex.rst index 4c9a4e0f8..cbbae98c1 100644 --- a/doc/latex.rst +++ b/doc/latex.rst @@ -484,7 +484,7 @@ Keys that don't need to be overridden unless in special cases are: .. versionchanged:: 1.8.3 Original ``\maketitle`` from document class is not overwritten, - hence is re-usable as part of some custom setting for this key. + hence is reusable as part of some custom setting for this key. .. versionadded:: 1.8.3 ``\sphinxbackoftitlepage`` optional macro. It can also be defined diff --git a/doc/usage/domains/python.rst b/doc/usage/domains/python.rst index 03872ef1d..96982f12e 100644 --- a/doc/usage/domains/python.rst +++ b/doc/usage/domains/python.rst @@ -155,7 +155,7 @@ The following directives are provided for module and class contents: .. rst:directive:: .. py:exception:: name .. py:exception:: name(parameters) - .. py:exception:: name[type parmeters](parameters) + .. py:exception:: name[type parameters](parameters) Describes an exception class. The signature can, but need not include parentheses with constructor arguments, @@ -192,7 +192,7 @@ The following directives are provided for module and class contents: .. rst:directive:: .. py:class:: name .. py:class:: name(parameters) - .. py:class:: name[type parmeters](parameters) + .. py:class:: name[type parameters](parameters) Describes a class. The signature can optionally include type parameters (see :pep:`695`) diff --git a/doc/usage/extensions/coverage.rst b/doc/usage/extensions/coverage.rst index 49a2334a1..b9c493b5f 100644 --- a/doc/usage/extensions/coverage.rst +++ b/doc/usage/extensions/coverage.rst @@ -62,7 +62,7 @@ should check: .. confval:: coverage_statistics_to_report - Print a tabluar report of the coverage statistics to the coverage report. + Print a tabular report of the coverage statistics to the coverage report. ``True`` by default. Example output: @@ -81,7 +81,7 @@ should check: .. confval:: coverage_statistics_to_stdout - Print a tabluar report of the coverage statistics to standard output. + Print a tabular report of the coverage statistics to standard output. ``False`` by default. Example output: diff --git a/doc/usage/quickstart.rst b/doc/usage/quickstart.rst index 01a1025a8..fcbfa80ee 100644 --- a/doc/usage/quickstart.rst +++ b/doc/usage/quickstart.rst @@ -18,7 +18,7 @@ its :doc:`significant extensibility capabilities `. The goal of this document is to give you a quick taste of what Sphinx is and how you might use it. When you're done here, you can check out the :doc:`installation guide ` followed by the intro to the -default markup format used by Sphinx, :doc:`reStucturedText +default markup format used by Sphinx, :doc:`reStructuredText `. For a great "introduction" to writing docs in general -- the whys and hows, see diff --git a/doc/usage/restructuredtext/roles.rst b/doc/usage/restructuredtext/roles.rst index eb1a94b39..5f190ae63 100644 --- a/doc/usage/restructuredtext/roles.rst +++ b/doc/usage/restructuredtext/roles.rst @@ -293,5 +293,5 @@ default. They are set in the build configuration file. .. describe:: |translation progress| Replaced by the translation progress of the document. - This substitution is intented for use by document translators + This substitution is intended for use by document translators as a marker for the translation progress of the document. diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index 824c2db2a..80c3eddc1 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -259,7 +259,7 @@ T = TypeVar('T') abstract-declarator[opt] # Drop the attributes -> decl-specifier-seq abstract-declarator[opt] - grammar, typedef-like: no initilizer + grammar, typedef-like: no initializer decl-specifier-seq declarator Can start with a templateDeclPrefix. @@ -7071,7 +7071,7 @@ class DefinitionParser(BaseParser): else: numParams = len(templatePrefix.templates) if numArgs + 1 < numParams: - self.fail("Too few template argument lists comapred to parameter" + self.fail("Too few template argument lists compared to parameter" " lists. Argument lists: %d, Parameter lists: %d." % (numArgs, numParams)) if numArgs > numParams: diff --git a/sphinx/environment/__init__.py b/sphinx/environment/__init__.py index f62b19045..dfb35bee6 100644 --- a/sphinx/environment/__init__.py +++ b/sphinx/environment/__init__.py @@ -299,7 +299,7 @@ class BuildEnvironment: # initialize config self._update_config(app.config) - # initialie settings + # initialize settings self._update_settings(app.config) def _update_config(self, config: Config) -> None: diff --git a/sphinx/ext/autosummary/__init__.py b/sphinx/ext/autosummary/__init__.py index 0498278fe..afc4d3b97 100644 --- a/sphinx/ext/autosummary/__init__.py +++ b/sphinx/ext/autosummary/__init__.py @@ -803,7 +803,7 @@ def process_generate_options(app: Sphinx) -> None: suffix = get_rst_suffix(app) if suffix is None: - logger.warning(__('autosummary generats .rst files internally. ' + logger.warning(__('autosummary generates .rst files internally. ' 'But your source_suffix does not contain .rst. Skipped.')) return diff --git a/sphinx/registry.py b/sphinx/registry.py index 8d4997998..f893e0dc5 100644 --- a/sphinx/registry.py +++ b/sphinx/registry.py @@ -60,7 +60,7 @@ class SphinxComponentRegistry: #: special attrgetter for autodoc; class object -> attrgetter self.autodoc_attrgettrs: dict[type, Callable[[Any, str, Any], Any]] = {} - #: builders; a dict of builder name -> bulider class + #: builders; a dict of builder name -> builder class self.builders: dict[str, type[Builder]] = {} #: autodoc documenters; a dict of documenter name -> documenter class diff --git a/sphinx/texinputs/sphinxlatextables.sty b/sphinx/texinputs/sphinxlatextables.sty index 9e4453259..380fc1705 100644 --- a/sphinx/texinputs/sphinxlatextables.sty +++ b/sphinx/texinputs/sphinxlatextables.sty @@ -564,7 +564,7 @@ % 99% or use case. Or perhaps some trick with storing in a \vbox and recovering % via some \vsplit but this becomes complicated... perhaps in future. % -% In passing we obtain baseline alignements across rows (only if +% In passing we obtain baseline alignments across rows (only if % \arraystretch is 1, as LaTeX's does not obey \arraystretch in "p" % multi-line contents, only first and last line...) % diff --git a/sphinx/themes/agogo/layout.html b/sphinx/themes/agogo/layout.html index 683383e71..2b32a42f5 100644 --- a/sphinx/themes/agogo/layout.html +++ b/sphinx/themes/agogo/layout.html @@ -76,7 +76,7 @@
-
+
{%- for rellink in rellinks|reverse %} {{ rellink[3] }} diff --git a/tests/roots/test-versioning/insert_beginning.txt b/tests/roots/test-versioning/insert_beginning.txt index 57102a76c..9b6e723e4 100644 --- a/tests/roots/test-versioning/insert_beginning.txt +++ b/tests/roots/test-versioning/insert_beginning.txt @@ -1,7 +1,7 @@ Versioning test text ==================== -Apperantly inserting a paragraph at the beginning of a document caused +Apparently inserting a paragraph at the beginning of a document caused problems earlier so this document should be used to test that. So the thing is I need some kind of text - not the lorem ipsum stuff, that diff --git a/tests/test_ext_autosectionlabel.py b/tests/test_ext_autosectionlabel.py index f99a6d3f6..e20d71347 100644 --- a/tests/test_ext_autosectionlabel.py +++ b/tests/test_ext_autosectionlabel.py @@ -42,7 +42,7 @@ def test_autosectionlabel_html(app, status, warning, skipped_labels=False): assert re.search(html, content, re.S) -# Re-use test definition from above, just change the test root directory +# Reuse test definition from above, just change the test root directory @pytest.mark.sphinx('html', testroot='ext-autosectionlabel-prefix-document') def test_autosectionlabel_prefix_document_html(app, status, warning): test_autosectionlabel_html(app, status, warning)