Skip to content

Commit 45371d4

Browse files
committed
Add basic pre-commit
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
1 parent e0c94cd commit 45371d4

File tree

2 files changed

+46
-0
lines changed

2 files changed

+46
-0
lines changed

.pre-commit-config.yaml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v4.3.0
4+
hooks:
5+
- id: trailing-whitespace
6+
- id: end-of-file-fixer
7+
- id: check-yaml
8+
- id: check-added-large-files
9+
- repo: https://github.com/executablebooks/mdformat
10+
rev: 0.7.16
11+
hooks:
12+
- id: mdformat
13+
additional_dependencies:
14+
- mdformat-gfm
15+
- mdformat-tables
16+
exclude: docs\/(?!README\.md).*
17+
# TODO: Temporarily separate docs formatiing
18+
# https://github.com/executablebooks/mdformat/issues/234
19+
- repo: https://github.com/executablebooks/mdformat
20+
rev: 0.7.16
21+
hooks:
22+
- id: mdformat
23+
additional_dependencies:
24+
- mdformat-myst
25+
files: docs\/(?!README).*\.md$
26+
- repo: https://github.com/python-jsonschema/check-jsonschema
27+
rev: 0.21.0
28+
hooks:
29+
- id: check-github-workflows
30+
- id: check-readthedocs

.readthedocs.yaml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
version: 2
2+
3+
python:
4+
install:
5+
- path: .
6+
extra_requirements:
7+
- docs
8+
build:
9+
os: ubuntu-22.04
10+
tools:
11+
python: "3.11"
12+
jobs:
13+
pre_build:
14+
- echo "Placeholder for doxygen builds via cmake"
15+
sphinx:
16+
configuration: doc/conf.py

0 commit comments

Comments
 (0)