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.

Sign up for GitHub

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

Jump to bottom

Add sphinx-lint to pre-commit configuration #2561

Merged
merged 3 commits into from
Mar 7, 2024
Merged

Add sphinx-lint to pre-commit configuration #2561

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
77dcbb1
Update version
namurphy Mar 7, 2024
b546713
Fix issues found by sphinx-lint
namurphy Mar 7, 2024
5d5fe0b
Edit changelog: 2561.internal.rst
namurphy Mar 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,11 @@ repos:
additional_dependencies:
- black==24.1.1

- repo: https://github.com/sphinx-contrib/sphinx-lint
rev: v0.9.1
hooks:
- id: sphinx-lint

- repo: https://github.com/nbQA-dev/nbQA
rev: 1.7.1
hooks:
Expand Down
2 changes: 2 additions & 0 deletions changelog/2561.internal.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Added ``sphinx-lint`` as a |pre-commit| hook to find
reStructuredText errors.
2 changes: 1 addition & 1 deletion changelog/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Changelog guidelines

* Changelog entries are not required for changes that are sufficiently
minor, such as typo fixes or fixed hyperlinks. When this is the case,
a package maintainer will add the :guilabel`no changelog entry needed`
a package maintainer will add the :guilabel:`no changelog entry needed`
label to the pull request.

* Use the past tense to describe the change, and the present tense to
Expand Down
2 changes: 1 addition & 1 deletion docs/plasma/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ a Plasma3D system, first create an instance of the
the :attr:`~plasmapy.plasma.sources.plasma3d.Plasma3D.density`,
:attr:`~plasmapy.plasma.sources.plasma3d.Plasma3D.momentum`,
:attr:`~plasmapy.plasma.sources.plasma3d.Plasma3D.pressure` and
attr:`~plasmapy.plasma.sources.plasma3d.Plasma3D.magnetic_field`.
:attr:`~plasmapy.plasma.sources.plasma3d.Plasma3D.magnetic_field`.

.. note::

Expand Down
4 changes: 2 additions & 2 deletions licenses/sphinx_license.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
License for Sphinx
==================

Copyright (c) 2007-2021 by the Sphinx team (see AUTHORS file).
Copyright (c) 2007-2024 by the Sphinx team (see AUTHORS file).
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down Expand Up @@ -177,7 +177,7 @@ met:
the documentation and/or other materials provided with the
distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
Expand Down