Skip to content

Commit b6df95f

Browse files
authored
Repair packaging (#73)
1 parent 3176315 commit b6df95f

14 files changed

+72
-14
lines changed

.pre-commit-config.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ repos:
2222
- id: mypy
2323
# empty args needed in order to match mypy cli behavior
2424
args: []
25-
entry: mypy doc8/
25+
entry: mypy src/
2626
pass_filenames: false
2727
additional_dependencies:
2828
- types-mock

MANIFEST.in

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
prune .github
2+
exclude .gitignore
3+
exclude .gitreview
4+
exclude .pre-commit-config.yaml
5+
exclude .pre-commit-hooks.yaml
6+
include *.md
7+
include *.py
8+
include *.txt
9+
include .coveragerc
10+
include .pylintrc
11+
include .yamllint
12+
include mypy.ini
13+
include tox.ini
14+
recursive-include docs *.ico
15+
recursive-include docs *.png
16+
recursive-include docs *.py
17+
recursive-include docs *.rst
18+
recursive-include src *.flake8
19+
recursive-include src *.j2
20+
recursive-include src *.json
21+
recursive-include src *.md
22+
recursive-include src *.py
23+
recursive-include src *.rst
24+
recursive-include src *.typed
25+
recursive-include src *.yaml
26+
recursive-include src *.yamllint
27+
recursive-include src *.yml
28+
recursive-include tools *.sh
29+
recursive-exclude .mypy_cache *.*
30+
recursive-exclude docs/docstree/html *.*
31+
recursive-exclude zuul.d *.*

setup.cfg

+38-13
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,30 @@
11
[metadata]
22
name = doc8
3-
summary = Style checker for Sphinx (or other) RST documentation
4-
description_file =
5-
README.rst
3+
url = https://github.com/pycqa/doc8
4+
project_urls =
5+
Bug Tracker = https://github.com/pycqa/doc8/issues
6+
Release Management = https://github.com/pycqa/doc8/releases
7+
CI = https://github.com/pycqa/doc8/actions
8+
Documentation = https://doc8.readthedocs.io
9+
Discussions = https://github.com/pycqa/doc8/discussions
10+
11+
description = Style checker for Sphinx (or other) RST documentation
12+
long_description = file: README.rst
13+
long_description_content_type = text/x-rst
614
author = OpenStack
715
author_email = [email protected]
816
maintainer = PyCQA
917
maintainer_email = [email protected]
10-
home_page = https://github.com/pycqa/doc8
11-
long_description_content_type = text/x-rst
12-
classifier =
18+
license = Apache 2.0
19+
license_file = LICENSE
20+
classifiers =
21+
Development Status :: 5 - Production/Stable
22+
23+
Environment :: Console
24+
25+
Intended Audience :: Developers
1326
Intended Audience :: Information Technology
1427
Intended Audience :: System Administrators
15-
Intended Audience :: Developers
16-
Development Status :: 4 - Beta
17-
Topic :: Utilities
1828
License :: OSI Approved :: Apache Software License
1929
Operating System :: POSIX :: Linux
2030
Programming Language :: Python
@@ -24,10 +34,12 @@ classifier =
2434
Programming Language :: Python :: 3.8
2535
Programming Language :: Python :: 3.9
2636
Programming Language :: Python :: 3.10
27-
28-
[entry_points]
29-
console_scripts =
30-
doc8 = doc8.main:main
37+
Topic :: System :: Systems Administration
38+
Topic :: Utilities
39+
keywords =
40+
doc8
41+
rst
42+
linter
3143

3244
[flake8]
3345
builtins = _
@@ -39,10 +51,23 @@ max_line_length=160
3951
extend_ignore = E203
4052

4153
[options]
54+
use_scm_version = True
4255
python_requires = >=3.6
56+
package_dir =
57+
= src
58+
packages = find:
59+
include_package_data = True
60+
zip_safe = False
4361
# These are required in actual runtime:
4462
install_requires =
4563
docutils
4664
restructuredtext-lint>=0.7
4765
stevedore
4866
Pygments
67+
68+
[options.entry_points]
69+
console_scripts =
70+
doc8 = doc8.main:main
71+
72+
[options.packages.find]
73+
where = src
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

tox.ini

+2
Original file line numberDiff line numberDiff line change
@@ -51,5 +51,7 @@ commands =
5151
pip uninstall -y doc8
5252
# Install the wheel
5353
sh -c "python3 -m pip install {toxinidir}/dist/*.whl"
54+
doc8 --version
55+
python -m doc8 --version
5456
# Ensure package can be uninstalled
5557
pip uninstall -y doc8

0 commit comments

Comments
 (0)