Skip to content

Commit 1e3a8fa

Browse files
pradyunsgjorisvandenbossche
pradyunsg
authored and
jorisvandenbossche
committed
Add a few pre-commit hooks for consistency across files
These make it much easier to not have minor nits across various files in the repository.
1 parent a93a2f5 commit 1e3a8fa

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+76
-64
lines changed

‎.pre-commit-config.yaml

+14
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# Exclude the generated static assets.
2+
exclude: .+(/static/).+|github_deploy_key_pandas_dev_pandas_sphinx_theme\.enc
3+
14
repos:
25
- repo: local
36
hooks:
@@ -17,3 +20,14 @@ repos:
1720
rev: 3.8.3
1821
hooks:
1922
- id: flake8
23+
24+
- repo: https://github.com/pre-commit/pre-commit-hooks
25+
rev: v4.0.1
26+
hooks:
27+
- id: check-builtin-literals
28+
- id: check-case-conflict
29+
- id: check-toml
30+
- id: check-yaml
31+
- id: debug-statements
32+
- id: end-of-file-fixer
33+
- id: trailing-whitespace

‎CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ the demo docs and developing the css/js of the theme, etc, is explained in
55
more detail in the contributing section of the documentation:
66

77
- [Contributing source files](docs/contributing.md)
8-
- [Contributing rendered docs](https://pydata-sphinx-theme.readthedocs.io/en/latest/contributing.html)
8+
- [Contributing rendered docs](https://pydata-sphinx-theme.readthedocs.io/en/latest/contributing.html)

‎docs/_static/pandas.svg

+1-1
Loading

‎docs/_templates/custom-template.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33
If you'd like to contribute,
44
<a href="https://github.com/pydata/pydata-sphinx-theme">check out our GitHub repository</a>
55
Your contributions are welcome!
6-
</div>
6+
</div>

‎docs/_templates/navbar-version.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
v{{ version }}
1+
v{{ version }}

‎docs/contributing.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -63,14 +63,14 @@ Or to completely remove the environment generated by ``nox`` and start from scra
6363

6464
If you'd like to use ``nox`` with your **global** environment (the one from
6565
which you are calling ``nox``), you can do so with
66-
66+
6767
.. code-block:: console
68-
68+
6969
$ nox --force-venv-backend none
7070
7171
# alternatively:
7272
$ nox -fb none
73-
73+
7474
Using `none` will re-use your current global environment. See
7575
`the nox documentation <https://nox.thea.codes/en/stable/usage.html#forcing-the-sessions-backend>`_
7676
for more details.
@@ -206,13 +206,13 @@ The easiest way to accomplish this is using `conda-forge <https://conda-forge.or
206206
Re recommend using node 14 as it is the latest LTS release of ``nodejs``.
207207

208208
2. **Initialize your yarn environment**:
209-
209+
210210
.. code-block:: console
211211
212212
$ yarn --frozen-lockfile
213213
214214
This will install all of the dependencies defined in ``yarn.lock`` and place them in a folder at ``node_modules/``.
215-
215+
216216
.. note::
217217

218218
If you do not include ``--frozen-lockfile``, then yarn will update all of the frozen dependency versions in ``yarn.lock``.

‎docs/demo/demo.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -466,7 +466,7 @@ Admonitions
466466
Version change
467467
--------------
468468

469-
You can write in your documentation when something has been changed,
469+
You can write in your documentation when something has been changed,
470470
added or deprecated from one version to another.
471471

472472
.. versionadded:: 0.1.1

‎docs/demo/markdown.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Sphinx can also generate pages from Markdown, using the [MyST Parser](https://myst-parser.readthedocs.io).
44
This page shows a few markdown-specific pieces of syntax.
5-
For a description of other markdown syntax that you can use with Sphinx, see [the `myst-parser` reference](https://myst-parser.readthedocs.io/en/latest/syntax/reference.html).
5+
For a description of other markdown syntax that you can use with Sphinx, see [the `myst-parser` reference](https://myst-parser.readthedocs.io/en/latest/syntax/reference.html).
66

77
## Horizontal rules
88

‎docs/demo/subpages/subpage1.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ finibus dictum velit. Ut eu efficitur arcu, id aliquam erat. In sit amet diam gr
66
gravida nisl. Praesent aliquet odio eget libero elementum, quis rhoncus tellus tincidunt.
77
Suspendisse quis volutpat ipsum. Sed lobortis scelerisque tristique. Aenean condimentum risus tellus,
88
quis accumsan ipsum laoreet ut. Integer porttitor maximus suscipit. Mauris in posuere sapien.
9-
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.
9+
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.

‎docs/demo/subpages/subpage2.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ finibus dictum velit. Ut eu efficitur arcu, id aliquam erat. In sit amet diam gr
66
gravida nisl. Praesent aliquet odio eget libero elementum, quis rhoncus tellus tincidunt.
77
Suspendisse quis volutpat ipsum. Sed lobortis scelerisque tristique. Aenean condimentum risus tellus,
88
quis accumsan ipsum laoreet ut. Integer porttitor maximus suscipit. Mauris in posuere sapien.
9-
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.
9+
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.

‎docs/demo/subpages/subsubpages/subsubpage1.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ finibus dictum velit. Ut eu efficitur arcu, id aliquam erat. In sit amet diam gr
66
gravida nisl. Praesent aliquet odio eget libero elementum, quis rhoncus tellus tincidunt.
77
Suspendisse quis volutpat ipsum. Sed lobortis scelerisque tristique. Aenean condimentum risus tellus,
88
quis accumsan ipsum laoreet ut. Integer porttitor maximus suscipit. Mauris in posuere sapien.
9-
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.
9+
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.

‎docs/demo/subpages/subsubpages/subsubpage10.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ finibus dictum velit. Ut eu efficitur arcu, id aliquam erat. In sit amet diam gr
66
gravida nisl. Praesent aliquet odio eget libero elementum, quis rhoncus tellus tincidunt.
77
Suspendisse quis volutpat ipsum. Sed lobortis scelerisque tristique. Aenean condimentum risus tellus,
88
quis accumsan ipsum laoreet ut. Integer porttitor maximus suscipit. Mauris in posuere sapien.
9-
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.
9+
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.

‎docs/demo/subpages/subsubpages/subsubpage11.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ finibus dictum velit. Ut eu efficitur arcu, id aliquam erat. In sit amet diam gr
66
gravida nisl. Praesent aliquet odio eget libero elementum, quis rhoncus tellus tincidunt.
77
Suspendisse quis volutpat ipsum. Sed lobortis scelerisque tristique. Aenean condimentum risus tellus,
88
quis accumsan ipsum laoreet ut. Integer porttitor maximus suscipit. Mauris in posuere sapien.
9-
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.
9+
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.

‎docs/demo/subpages/subsubpages/subsubpage12.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ finibus dictum velit. Ut eu efficitur arcu, id aliquam erat. In sit amet diam gr
66
gravida nisl. Praesent aliquet odio eget libero elementum, quis rhoncus tellus tincidunt.
77
Suspendisse quis volutpat ipsum. Sed lobortis scelerisque tristique. Aenean condimentum risus tellus,
88
quis accumsan ipsum laoreet ut. Integer porttitor maximus suscipit. Mauris in posuere sapien.
9-
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.
9+
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.

‎docs/demo/subpages/subsubpages/subsubpage13.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ finibus dictum velit. Ut eu efficitur arcu, id aliquam erat. In sit amet diam gr
66
gravida nisl. Praesent aliquet odio eget libero elementum, quis rhoncus tellus tincidunt.
77
Suspendisse quis volutpat ipsum. Sed lobortis scelerisque tristique. Aenean condimentum risus tellus,
88
quis accumsan ipsum laoreet ut. Integer porttitor maximus suscipit. Mauris in posuere sapien.
9-
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.
9+
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.

‎docs/demo/subpages/subsubpages/subsubpage14.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ finibus dictum velit. Ut eu efficitur arcu, id aliquam erat. In sit amet diam gr
66
gravida nisl. Praesent aliquet odio eget libero elementum, quis rhoncus tellus tincidunt.
77
Suspendisse quis volutpat ipsum. Sed lobortis scelerisque tristique. Aenean condimentum risus tellus,
88
quis accumsan ipsum laoreet ut. Integer porttitor maximus suscipit. Mauris in posuere sapien.
9-
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.
9+
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.

‎docs/demo/subpages/subsubpages/subsubpage15.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ finibus dictum velit. Ut eu efficitur arcu, id aliquam erat. In sit amet diam gr
66
gravida nisl. Praesent aliquet odio eget libero elementum, quis rhoncus tellus tincidunt.
77
Suspendisse quis volutpat ipsum. Sed lobortis scelerisque tristique. Aenean condimentum risus tellus,
88
quis accumsan ipsum laoreet ut. Integer porttitor maximus suscipit. Mauris in posuere sapien.
9-
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.
9+
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.

‎docs/demo/subpages/subsubpages/subsubpage16.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ finibus dictum velit. Ut eu efficitur arcu, id aliquam erat. In sit amet diam gr
66
gravida nisl. Praesent aliquet odio eget libero elementum, quis rhoncus tellus tincidunt.
77
Suspendisse quis volutpat ipsum. Sed lobortis scelerisque tristique. Aenean condimentum risus tellus,
88
quis accumsan ipsum laoreet ut. Integer porttitor maximus suscipit. Mauris in posuere sapien.
9-
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.
9+
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.

‎docs/demo/subpages/subsubpages/subsubpage17.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ finibus dictum velit. Ut eu efficitur arcu, id aliquam erat. In sit amet diam gr
66
gravida nisl. Praesent aliquet odio eget libero elementum, quis rhoncus tellus tincidunt.
77
Suspendisse quis volutpat ipsum. Sed lobortis scelerisque tristique. Aenean condimentum risus tellus,
88
quis accumsan ipsum laoreet ut. Integer porttitor maximus suscipit. Mauris in posuere sapien.
9-
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.
9+
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.

‎docs/demo/subpages/subsubpages/subsubpage18.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ finibus dictum velit. Ut eu efficitur arcu, id aliquam erat. In sit amet diam gr
66
gravida nisl. Praesent aliquet odio eget libero elementum, quis rhoncus tellus tincidunt.
77
Suspendisse quis volutpat ipsum. Sed lobortis scelerisque tristique. Aenean condimentum risus tellus,
88
quis accumsan ipsum laoreet ut. Integer porttitor maximus suscipit. Mauris in posuere sapien.
9-
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.
9+
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.

‎docs/demo/subpages/subsubpages/subsubpage19.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ finibus dictum velit. Ut eu efficitur arcu, id aliquam erat. In sit amet diam gr
66
gravida nisl. Praesent aliquet odio eget libero elementum, quis rhoncus tellus tincidunt.
77
Suspendisse quis volutpat ipsum. Sed lobortis scelerisque tristique. Aenean condimentum risus tellus,
88
quis accumsan ipsum laoreet ut. Integer porttitor maximus suscipit. Mauris in posuere sapien.
9-
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.
9+
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.

‎docs/demo/subpages/subsubpages/subsubpage2.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ finibus dictum velit. Ut eu efficitur arcu, id aliquam erat. In sit amet diam gr
66
gravida nisl. Praesent aliquet odio eget libero elementum, quis rhoncus tellus tincidunt.
77
Suspendisse quis volutpat ipsum. Sed lobortis scelerisque tristique. Aenean condimentum risus tellus,
88
quis accumsan ipsum laoreet ut. Integer porttitor maximus suscipit. Mauris in posuere sapien.
9-
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.
9+
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.

‎docs/demo/subpages/subsubpages/subsubpage20.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ finibus dictum velit. Ut eu efficitur arcu, id aliquam erat. In sit amet diam gr
66
gravida nisl. Praesent aliquet odio eget libero elementum, quis rhoncus tellus tincidunt.
77
Suspendisse quis volutpat ipsum. Sed lobortis scelerisque tristique. Aenean condimentum risus tellus,
88
quis accumsan ipsum laoreet ut. Integer porttitor maximus suscipit. Mauris in posuere sapien.
9-
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.
9+
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.

‎docs/demo/subpages/subsubpages/subsubpage3.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ finibus dictum velit. Ut eu efficitur arcu, id aliquam erat. In sit amet diam gr
66
gravida nisl. Praesent aliquet odio eget libero elementum, quis rhoncus tellus tincidunt.
77
Suspendisse quis volutpat ipsum. Sed lobortis scelerisque tristique. Aenean condimentum risus tellus,
88
quis accumsan ipsum laoreet ut. Integer porttitor maximus suscipit. Mauris in posuere sapien.
9-
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.
9+
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.

‎docs/demo/subpages/subsubpages/subsubpage4.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ finibus dictum velit. Ut eu efficitur arcu, id aliquam erat. In sit amet diam gr
66
gravida nisl. Praesent aliquet odio eget libero elementum, quis rhoncus tellus tincidunt.
77
Suspendisse quis volutpat ipsum. Sed lobortis scelerisque tristique. Aenean condimentum risus tellus,
88
quis accumsan ipsum laoreet ut. Integer porttitor maximus suscipit. Mauris in posuere sapien.
9-
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.
9+
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.

‎docs/demo/subpages/subsubpages/subsubpage5.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ finibus dictum velit. Ut eu efficitur arcu, id aliquam erat. In sit amet diam gr
66
gravida nisl. Praesent aliquet odio eget libero elementum, quis rhoncus tellus tincidunt.
77
Suspendisse quis volutpat ipsum. Sed lobortis scelerisque tristique. Aenean condimentum risus tellus,
88
quis accumsan ipsum laoreet ut. Integer porttitor maximus suscipit. Mauris in posuere sapien.
9-
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.
9+
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.

‎docs/demo/subpages/subsubpages/subsubpage6.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ finibus dictum velit. Ut eu efficitur arcu, id aliquam erat. In sit amet diam gr
66
gravida nisl. Praesent aliquet odio eget libero elementum, quis rhoncus tellus tincidunt.
77
Suspendisse quis volutpat ipsum. Sed lobortis scelerisque tristique. Aenean condimentum risus tellus,
88
quis accumsan ipsum laoreet ut. Integer porttitor maximus suscipit. Mauris in posuere sapien.
9-
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.
9+
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.

0 commit comments

Comments
 (0)