Skip to content

Commit

Permalink
Fix various spelling errors (#11735)
Browse files Browse the repository at this point in the history
  • Loading branch information
DimitriPapadopoulos committed Jan 4, 2024
1 parent efd24cf commit 460a630
Show file tree
Hide file tree
Showing 14 changed files with 17 additions and 17 deletions.
2 changes: 1 addition & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Here are some of Sphinx's major features:
<builtin-extensions>`, and much more functionality via :ref:`third-party
extensions <third-party-extensions>`.
* **Themes:** modify the look and feel of outputs via :doc:`creating themes
<development/theming>`, and re-use many :ref:`third-party themes
<development/theming>`, and reuse many :ref:`third-party themes
<third-party-themes>`.
* **Contributed extensions:** dozens of extensions :ref:`contributed by users
<third-party-extensions>`; most of them installable from PyPI.
Expand Down
2 changes: 1 addition & 1 deletion doc/latex.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions doc/usage/domains/python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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`)
Expand Down
4 changes: 2 additions & 2 deletions doc/usage/extensions/coverage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion doc/usage/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ its :doc:`significant extensibility capabilities </development/index>`.
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 </usage/installation>` followed by the intro to the
default markup format used by Sphinx, :doc:`reStucturedText
default markup format used by Sphinx, :doc:`reStructuredText
</usage/restructuredtext/index>`.

For a great "introduction" to writing docs in general -- the whys and hows, see
Expand Down
2 changes: 1 addition & 1 deletion doc/usage/restructuredtext/roles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 2 additions & 2 deletions sphinx/domains/cpp.py
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@
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.
Expand Down Expand Up @@ -7071,7 +7071,7 @@ def _check_template_consistency(self, nestedName: ASTNestedName,
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:
Expand Down
2 changes: 1 addition & 1 deletion sphinx/environment/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ def setup(self, app: Sphinx) -> None:
# initialize config
self._update_config(app.config)

# initialie settings
# initialize settings
self._update_settings(app.config)

def _update_config(self, config: Config) -> None:
Expand Down
2 changes: 1 addition & 1 deletion sphinx/ext/autosummary/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion sphinx/registry.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ def __init__(self) -> None:
#: 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
Expand Down
2 changes: 1 addition & 1 deletion sphinx/texinputs/sphinxlatextables.sty
Original file line number Diff line number Diff line change
Expand Up @@ -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...)
%
Expand Down
2 changes: 1 addition & 1 deletion sphinx/themes/agogo/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ <h3 style="margin-top: 1.5em;">{{ _('Search') }}</h3>
<div class="footer-wrapper">
<div class="footer">
<div class="left">
<div role="navigation" aria-label="related navigaton">
<div role="navigation" aria-label="related navigation">
{%- for rellink in rellinks|reverse %}
<a href="{{ pathto(rellink[0])|e }}" title="{{ rellink[1]|striptags|e }}"
{{ accesskey(rellink[2]) }}>{{ rellink[3] }}</a>
Expand Down
2 changes: 1 addition & 1 deletion tests/roots/test-versioning/insert_beginning.txt
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion tests/test_ext_autosectionlabel.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit 460a630

Please sign in to comment.