Skip to content

Commit dc32fac

Browse files
repo-helper[bot]repo-helper[bot]
authored
Updated files with 'repo_helper'. (#21)
Co-authored-by: repo-helper[bot] <74742576+repo-helper[bot]@users.noreply.github.com>
1 parent 1fa325b commit dc32fac

File tree

12 files changed

+169
-130
lines changed

12 files changed

+169
-130
lines changed

‎.bumpversion.cfg

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,5 @@ tag = True
1212
[bumpversion:file:repo_helper.yml]
1313

1414
[bumpversion:file:flake8_sphinx_links/__init__.py]
15+
16+
[bumpversion:file:pyproject.toml]

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,10 @@ THE ISSUE WILL BE CLOSED IF INSUFFICIENT INFORMATION IS PROVIDED.
1717

1818

1919
## Steps to Reproduce
20-
<!--Please add a series of steps to reproduce the issue-->
20+
<!--Please add a series of steps to reproduce the issue.
21+
22+
If possible, please include a small, self-contained reproduction.
23+
-->
2124

2225
1.
2326
2.

‎.pylintrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ confidence=
6666
# no Warning level messages displayed, use"--disable=all --enable=classes
6767
# --disable=W"
6868
disable=all
69-
enable=assert-on-tuple,astroid-error,bad-except-order,bad-inline-option,bad-option-value,bad-reversed-sequence,bare-except,binary-op-exception,boolean-datetime,catching-non-exception,cell-var-from-loop,confusing-with-statement,consider-merging-isinstance,consider-using-enumerate,consider-using-ternary,continue-in-finally,cyclic-import,deprecated-pragma,django-not-available,duplicate-except,duplicate-key,eval-used,exec-used,expression-not-assigned,fatal,file-ignored,fixme,global-at-module-level,global-statement,global-variable-not-assigned,global-variable-undefined,http-response-with-content-type-json,http-response-with-json-dumps,invalid-all-object,invalid-characters-in-docstring,len-as-condition,literal-comparison,locally-disabled,locally-enabled,lost-exception,lowercase-l-suffix,misplaced-bare-raise,missing-kwoa,mixed-line-endings,model-has-unicode,model-missing-unicode,model-no-explicit-unicode,model-unicode-not-callable,multiple-imports,multiple-statements,new-db-field-with-default,non-ascii-bytes-literals,nonexistent-operator,not-in-loop,notimplemented-raised,overlapping-except,parse-error,pointless-statement,pointless-string-statement,raising-bad-type,raising-non-exception,raw-checker-failed,redefine-in-handler,redefined-argument-from-local,redefined-builtin,redundant-content-type-for-json-response,reimported,relative-import,return-outside-function,simplifiable-if-statement,singleton-comparison,syntax-error,trailing-comma-tuple,trailing-newlines,unbalanced-tuple-unpacking,undefined-all-variable,undefined-loop-variable,unexpected-line-ending-format,unidiomatic-typecheck,unnecessary-lambda,unnecessary-pass,unnecessary-semicolon,unneeded-not,unpacking-non-sequence,unreachable,unrecognized-inline-option,used-before-assignment,useless-else-on-loop,using-constant-test,wildcard-import,yield-outside-function,useless-return
69+
enable=assert-on-tuple,astroid-error,bad-except-order,bad-inline-option,bad-option-value,bad-reversed-sequence,bare-except,binary-op-exception,boolean-datetime,catching-non-exception,cell-var-from-loop,confusing-with-statement,consider-merging-isinstance,consider-using-enumerate,consider-using-ternary,continue-in-finally,cyclic-import,deprecated-pragma,django-not-available,duplicate-except,duplicate-key,eval-used,exec-used,expression-not-assigned,fatal,file-ignored,fixme,global-at-module-level,global-statement,global-variable-not-assigned,global-variable-undefined,http-response-with-content-type-json,http-response-with-json-dumps,invalid-all-object,invalid-characters-in-docstring,len-as-condition,literal-comparison,locally-disabled,locally-enabled,lost-exception,lowercase-l-suffix,misplaced-bare-raise,missing-kwoa,mixed-line-endings,model-has-unicode,model-missing-unicode,model-no-explicit-unicode,model-unicode-not-callable,multiple-imports,new-db-field-with-default,non-ascii-bytes-literals,nonexistent-operator,not-in-loop,notimplemented-raised,overlapping-except,parse-error,pointless-statement,pointless-string-statement,raising-bad-type,raising-non-exception,raw-checker-failed,redefine-in-handler,redefined-argument-from-local,redefined-builtin,redundant-content-type-for-json-response,reimported,relative-import,return-outside-function,simplifiable-if-statement,singleton-comparison,syntax-error,trailing-comma-tuple,trailing-newlines,unbalanced-tuple-unpacking,undefined-all-variable,undefined-loop-variable,unexpected-line-ending-format,unidiomatic-typecheck,unnecessary-lambda,unnecessary-pass,unnecessary-semicolon,unneeded-not,unpacking-non-sequence,unreachable,unrecognized-inline-option,used-before-assignment,useless-else-on-loop,using-constant-test,wildcard-import,yield-outside-function,useless-return
7070

7171
[REPORTS]
7272

‎.readthedocs.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ version: 2
55
sphinx:
66
builder: html
77
configuration: doc-source/conf.py
8-
formats: all
8+
formats:
9+
- pdf
10+
- htmlzip
911
python:
1012
version: 3.8
1113
install:

‎__pkginfo__.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
"""
2828

2929
__version__ = "0.1.0"
30-
3130
repo_root = pathlib.Path(__file__).parent
3231
install_requires = (repo_root / "requirements.txt").read_text(encoding="utf-8").split('\n')
33-
extras_require = {"all": []}
32+
extras_require = {}

‎doc-source/conf.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
"""
2424

2525
author = "Dominic Davis-Foster"
26-
project = "flake8_sphinx_links"
26+
project = "flake8_sphinx_links".replace('_', '-')
2727
slug = re.sub(r'\W+', '-', project.lower())
2828
release = version = __version__
2929
copyright = "2020-2021 Dominic Davis-Foster" # pylint: disable=redefined-builtin
@@ -35,6 +35,7 @@
3535
"sphinx_toolbox.more_autodoc",
3636
"sphinx_toolbox.more_autosummary",
3737
"sphinx_toolbox.tweaks.param_dash",
38+
"sphinx_toolbox.tweaks.latex_toc",
3839
"sphinx.ext.intersphinx",
3940
"sphinx.ext.mathjax",
4041
"sphinxcontrib.httpdomain",
@@ -45,6 +46,7 @@
4546
"sphinx_copybutton",
4647
"sphinxcontrib.default_values",
4748
"sphinxcontrib.toctree_plus",
49+
"sphinx_debuginfo",
4850
"seed_intersphinx_mapping",
4951
"sphinx_toolbox.pre_commit",
5052
"sphinx_toolbox.flake8",

‎doc-source/index.rst

Lines changed: 116 additions & 112 deletions
Original file line numberDiff line numberDiff line change
@@ -10,116 +10,118 @@ flake8_sphinx_links
1010
1111
.. start shields
1212
13-
.. list-table::
14-
:stub-columns: 1
15-
:widths: 10 90
16-
17-
* - Docs
18-
- |docs| |docs_check|
19-
* - Tests
20-
- |actions_linux| |actions_windows| |actions_macos| |coveralls|
21-
* - PyPI
22-
- |pypi-version| |supported-versions| |supported-implementations| |wheel|
23-
* - Anaconda
24-
- |conda-version| |conda-platform|
25-
* - Activity
26-
- |commits-latest| |commits-since| |maintained| |pypi-downloads|
27-
* - QA
28-
- |codefactor| |actions_flake8| |actions_mypy| |pre_commit_ci|
29-
* - Other
30-
- |license| |language| |requires|
31-
32-
.. |docs| rtfd-shield::
33-
:project: flake8-sphinx-links
34-
:alt: Documentation Build Status
35-
36-
.. |docs_check| actions-shield::
37-
:workflow: Docs Check
38-
:alt: Docs Check Status
39-
40-
.. |actions_linux| actions-shield::
41-
:workflow: Linux
42-
:alt: Linux Test Status
43-
44-
.. |actions_windows| actions-shield::
45-
:workflow: Windows
46-
:alt: Windows Test Status
47-
48-
.. |actions_macos| actions-shield::
49-
:workflow: macOS
50-
:alt: macOS Test Status
51-
52-
.. |actions_flake8| actions-shield::
53-
:workflow: Flake8
54-
:alt: Flake8 Status
55-
56-
.. |actions_mypy| actions-shield::
57-
:workflow: mypy
58-
:alt: mypy status
59-
60-
.. |requires| requires-io-shield::
61-
:alt: Requirements Status
62-
63-
.. |coveralls| coveralls-shield::
64-
:alt: Coverage
65-
66-
.. |codefactor| codefactor-shield::
67-
:alt: CodeFactor Grade
68-
69-
.. |pypi-version| pypi-shield::
70-
:project: flake8_sphinx_links
71-
:version:
72-
:alt: PyPI - Package Version
73-
74-
.. |supported-versions| pypi-shield::
75-
:project: flake8_sphinx_links
76-
:py-versions:
77-
:alt: PyPI - Supported Python Versions
78-
79-
.. |supported-implementations| pypi-shield::
80-
:project: flake8_sphinx_links
81-
:implementations:
82-
:alt: PyPI - Supported Implementations
83-
84-
.. |wheel| pypi-shield::
85-
:project: flake8_sphinx_links
86-
:wheel:
87-
:alt: PyPI - Wheel
88-
89-
.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/flake8_sphinx_links?logo=anaconda
90-
:target: https://anaconda.org/domdfcoding/flake8_sphinx_links
91-
:alt: Conda - Package Version
92-
93-
.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/flake8_sphinx_links?label=conda%7Cplatform
94-
:target: https://anaconda.org/domdfcoding/flake8_sphinx_links
95-
:alt: Conda - Platform
96-
97-
.. |license| github-shield::
98-
:license:
99-
:alt: License
100-
101-
.. |language| github-shield::
102-
:top-language:
103-
:alt: GitHub top language
104-
105-
.. |commits-since| github-shield::
106-
:commits-since: v0.1.0
107-
:alt: GitHub commits since tagged version
108-
109-
.. |commits-latest| github-shield::
110-
:last-commit:
111-
:alt: GitHub last commit
112-
113-
.. |maintained| maintained-shield:: 2021
114-
:alt: Maintenance
115-
116-
.. |pypi-downloads| pypi-shield::
117-
:project: flake8_sphinx_links
118-
:downloads: month
119-
:alt: PyPI - Downloads
120-
121-
.. |pre_commit_ci| pre-commit-ci-shield::
122-
:alt: pre-commit.ci status
13+
.. only:: html
14+
15+
.. list-table::
16+
:stub-columns: 1
17+
:widths: 10 90
18+
19+
* - Docs
20+
- |docs| |docs_check|
21+
* - Tests
22+
- |actions_linux| |actions_windows| |actions_macos| |coveralls|
23+
* - PyPI
24+
- |pypi-version| |supported-versions| |supported-implementations| |wheel|
25+
* - Anaconda
26+
- |conda-version| |conda-platform|
27+
* - Activity
28+
- |commits-latest| |commits-since| |maintained| |pypi-downloads|
29+
* - QA
30+
- |codefactor| |actions_flake8| |actions_mypy| |pre_commit_ci|
31+
* - Other
32+
- |license| |language| |requires|
33+
34+
.. |docs| rtfd-shield::
35+
:project: flake8-sphinx-links
36+
:alt: Documentation Build Status
37+
38+
.. |docs_check| actions-shield::
39+
:workflow: Docs Check
40+
:alt: Docs Check Status
41+
42+
.. |actions_linux| actions-shield::
43+
:workflow: Linux
44+
:alt: Linux Test Status
45+
46+
.. |actions_windows| actions-shield::
47+
:workflow: Windows
48+
:alt: Windows Test Status
49+
50+
.. |actions_macos| actions-shield::
51+
:workflow: macOS
52+
:alt: macOS Test Status
53+
54+
.. |actions_flake8| actions-shield::
55+
:workflow: Flake8
56+
:alt: Flake8 Status
57+
58+
.. |actions_mypy| actions-shield::
59+
:workflow: mypy
60+
:alt: mypy status
61+
62+
.. |requires| requires-io-shield::
63+
:alt: Requirements Status
64+
65+
.. |coveralls| coveralls-shield::
66+
:alt: Coverage
67+
68+
.. |codefactor| codefactor-shield::
69+
:alt: CodeFactor Grade
70+
71+
.. |pypi-version| pypi-shield::
72+
:project: flake8_sphinx_links
73+
:version:
74+
:alt: PyPI - Package Version
75+
76+
.. |supported-versions| pypi-shield::
77+
:project: flake8_sphinx_links
78+
:py-versions:
79+
:alt: PyPI - Supported Python Versions
80+
81+
.. |supported-implementations| pypi-shield::
82+
:project: flake8_sphinx_links
83+
:implementations:
84+
:alt: PyPI - Supported Implementations
85+
86+
.. |wheel| pypi-shield::
87+
:project: flake8_sphinx_links
88+
:wheel:
89+
:alt: PyPI - Wheel
90+
91+
.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/flake8_sphinx_links?logo=anaconda
92+
:target: https://anaconda.org/domdfcoding/flake8_sphinx_links
93+
:alt: Conda - Package Version
94+
95+
.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/flake8_sphinx_links?label=conda%7Cplatform
96+
:target: https://anaconda.org/domdfcoding/flake8_sphinx_links
97+
:alt: Conda - Platform
98+
99+
.. |license| github-shield::
100+
:license:
101+
:alt: License
102+
103+
.. |language| github-shield::
104+
:top-language:
105+
:alt: GitHub top language
106+
107+
.. |commits-since| github-shield::
108+
:commits-since: v0.1.0
109+
:alt: GitHub commits since tagged version
110+
111+
.. |commits-latest| github-shield::
112+
:last-commit:
113+
:alt: GitHub last commit
114+
115+
.. |maintained| maintained-shield:: 2021
116+
:alt: Maintenance
117+
118+
.. |pypi-downloads| pypi-shield::
119+
:project: flake8_sphinx_links
120+
:downloads: month
121+
:alt: PyPI - Downloads
122+
123+
.. |pre_commit_ci| pre-commit-ci-shield::
124+
:alt: pre-commit.ci status
123125

124126
.. end shields
125127
@@ -175,8 +177,10 @@ Sample ``.pre-commit-config.yaml``:
175177

176178
.. start links
177179
178-
View the :ref:`Function Index <genindex>` or browse the `Source Code <_modules/index.html>`__.
180+
.. only:: html
179181

180-
`Browse the GitHub Repository <https://github.com/domdfcoding/flake8-sphinx-links>`__
182+
View the :ref:`Function Index <genindex>` or browse the `Source Code <_modules/index.html>`__.
183+
184+
`Browse the GitHub Repository <https://github.com/domdfcoding/flake8-sphinx-links>`__
181185

182186
.. end links

‎doc-source/requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@ repo-helper-sphinx-theme>=0.0.2
77
seed-intersphinx-mapping>=0.3.1
88
sphinx<3.4.0,>=3.0.3
99
sphinx-copybutton>=0.2.12
10+
sphinx-debuginfo>=0.1.0
1011
sphinx-notfound-page>=0.5
1112
sphinx-prompt>=1.1.0
1213
sphinx-tabs>=1.1.13
13-
sphinx-toolbox>=1.8.3
14+
sphinx-toolbox>=2.1.0
1415
sphinxcontrib-httpdomain>=1.7.0
1516
sphinxemoji>=0.1.6
1617
tabulate>=0.8.7

‎pyproject.toml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,26 @@
11
[build-system]
22
requires = [ "setuptools>=40.6.0", "wheel>=0.34.2",]
33
build-backend = "setuptools.build_meta"
4+
5+
[project]
6+
name = "flake8_sphinx_links"
7+
version = "0.1.0"
8+
description = "A Flake8 plugin to check docstrings for double backticked strings which should be links to the Python documentation."
9+
readme = "README.rst"
10+
keywords = []
11+
dynamic = [ "requires-python", "classifiers", "dependencies",]
12+
[[project.authors]]
13+
email = "dominic@davis-foster.co.uk"
14+
name = "Dominic Davis-Foster"
15+
16+
[project.license]
17+
file = "LICENSE"
18+
19+
[project.urls]
20+
Homepage = "https://github.com/domdfcoding/flake8-sphinx-links"
21+
"Issue Tracker" = "https://github.com/domdfcoding/flake8-sphinx-links/issues"
22+
"Source Code" = "https://github.com/domdfcoding/flake8-sphinx-links"
23+
Documentation = "https://flake8-sphinx-links.readthedocs.io/en/latest"
24+
25+
[project.entry-points."flake8.extension"]
26+
SXL = "flake8_sphinx_links:Plugin"

‎setup.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
# This file is managed by 'repo_helper'. Don't edit it directly.
33

44
# stdlib
5+
import shutil
56
import sys
67

78
# 3rd party
@@ -20,3 +21,5 @@
2021
py_modules=[],
2122
version=__version__,
2223
)
24+
25+
shutil.rmtree("flake8_sphinx_links.egg-info", ignore_errors=True)

‎tests/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
coincidence>=0.1.0
22
coverage>=5.1
3-
coverage-pyver-pragma>=0.0.6
3+
coverage-pyver-pragma>=0.2.1
44
domdf-python-tools[testing]>=2.0.1
55
iniconfig!=1.1.0,>=1.0.1
66
pytest>=6.0.0

0 commit comments

Comments
 (0)