Skip to content

Commit 01a32ad

Browse files
committed
Updated deps & using pre-commit action
1 parent d774728 commit 01a32ad

File tree

8 files changed

+557
-422
lines changed

8 files changed

+557
-422
lines changed

.cicd/build_images.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
1+
22
version: 0.2
33
env:
44
shell: /bin/bash

.cicd/buildspec_docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
1+
22
version: 0.2
33
env:
44
shell: /bin/bash
File renamed without changes.
File renamed without changes.

.github/workflows/pre-commit.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: pre-commit
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches: [main]
7+
8+
jobs:
9+
pre-commit:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v3
13+
- uses: actions/setup-python@v3
14+
- uses: pre-commit/[email protected]

.pre-commit-config.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ repos:
77
- id: check-case-conflict
88
- id: check-json
99
- id: check-yaml
10+
exclude: .cicd/*.template
1011
- id: check-toml
1112
- id: end-of-file-fixer
1213
- id: trailing-whitespace
@@ -16,14 +17,14 @@ repos:
1617
- id: fix-byte-order-marker
1718

1819
- repo: https://github.com/asottile/pyupgrade
19-
rev: v3.8.0
20+
rev: v3.10.1
2021
hooks:
2122
- id: pyupgrade
2223
args: [ "--py38-plus" ]
2324
exclude: ^ecs_files_composer/input.py|docs/
2425

2526
- repo: https://github.com/psf/black
26-
rev: 23.3.0
27+
rev: 23.7.0
2728
hooks:
2829
- id: black
2930
- repo: https://github.com/pycqa/isort

docs/conf.py

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
import os
2121
import sys
2222

23-
sys.path.insert(0, os.path.abspath('..'))
23+
sys.path.insert(0, os.path.abspath(".."))
2424

2525
import ecs_files_composer
2626

@@ -32,22 +32,22 @@
3232

3333
# Add any Sphinx extension module names here, as strings. They can be
3434
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
35-
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
35+
extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"]
3636

3737
# Add any paths that contain templates here, relative to this directory.
38-
templates_path = ['_templates']
38+
templates_path = ["_templates"]
3939

4040
# The suffix(es) of source filenames.
4141
# You can specify multiple suffix as a list of string:
4242
#
4343
# source_suffix = ['.rst', '.md']
44-
source_suffix = '.rst'
44+
source_suffix = ".rst"
4545

4646
# The master toctree document.
47-
master_doc = 'index'
47+
master_doc = "index"
4848

4949
# General information about the project.
50-
project = 'ECS Files Composer'
50+
project = "ECS Files Composer"
5151
copyright = "2021, John Preston"
5252
author = "John Preston"
5353

@@ -70,10 +70,10 @@
7070
# List of patterns, relative to source directory, that match files and
7171
# directories to ignore when looking for source files.
7272
# This patterns also effect to html_static_path and html_extra_path
73-
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
73+
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
7474

7575
# The name of the Pygments (syntax highlighting) style to use.
76-
pygments_style = 'sphinx'
76+
pygments_style = "sphinx"
7777

7878
# If true, `todo` and `todoList` produce output, else they produce nothing.
7979
todo_include_todos = False
@@ -137,14 +137,16 @@
137137
# Add any paths that contain custom static files (such as style sheets) here,
138138
# relative to this directory. They are copied after the builtin static files,
139139
# so a file named "default.css" will overwrite the builtin "default.css".
140-
html_static_path = ['_static']
140+
html_static_path = ["_static"]
141141
html_show_sourcelink = True
142-
html_sidebars = {"**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]}
142+
html_sidebars = {
143+
"**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]
144+
}
143145

144146
# -- Options for HTMLHelp output ---------------------------------------
145147

146148
# Output file base name for HTML help builder.
147-
htmlhelp_basename = 'ecs_files_composerdoc'
149+
htmlhelp_basename = "ecs_files_composerdoc"
148150

149151

150152
# -- Options for LaTeX output ------------------------------------------
@@ -168,14 +170,22 @@
168170
# (source start file, target name, title, author, documentclass
169171
# [howto, manual, or own class]).
170172
latex_documents = [
171-
(master_doc, 'ecs_files_composer.tex', 'ECS Files Composer Documentation', 'John Preston', 'manual'),
173+
(
174+
master_doc,
175+
"ecs_files_composer.tex",
176+
"ECS Files Composer Documentation",
177+
"John Preston",
178+
"manual",
179+
),
172180
]
173181

174182
# -- Options for manual page output ------------------------------------
175183

176184
# One entry per manual page. List of tuples
177185
# (source start file, name, description, authors, manual section).
178-
man_pages = [(master_doc, 'ecs_files_composer', 'ECS Files Composer Documentation', [author], 1)]
186+
man_pages = [
187+
(master_doc, "ecs_files_composer", "ECS Files Composer Documentation", [author], 1)
188+
]
179189

180190
# -- Options for Texinfo output ----------------------------------------
181191

@@ -185,11 +195,11 @@
185195
texinfo_documents = [
186196
(
187197
master_doc,
188-
'ecs_files_composer',
189-
'ECS Files Composer Documentation',
198+
"ecs_files_composer",
199+
"ECS Files Composer Documentation",
190200
author,
191-
'ecs_files_composer',
192-
'One line description of project.',
193-
'Miscellaneous',
201+
"ecs_files_composer",
202+
"One line description of project.",
203+
"Miscellaneous",
194204
),
195205
]

0 commit comments

Comments
 (0)