Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Repair packaging #73

Merged
merged 1 commit into from
Nov 10, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ repos:
- id: mypy
# empty args needed in order to match mypy cli behavior
args: []
entry: mypy doc8/
entry: mypy src/
pass_filenames: false
additional_dependencies:
- types-mock
Expand Down
31 changes: 31 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
prune .github
exclude .gitignore
exclude .gitreview
exclude .pre-commit-config.yaml
exclude .pre-commit-hooks.yaml
include *.md
include *.py
include *.txt
include .coveragerc
include .pylintrc
include .yamllint
include mypy.ini
include tox.ini
recursive-include docs *.ico
recursive-include docs *.png
recursive-include docs *.py
recursive-include docs *.rst
recursive-include src *.flake8
recursive-include src *.j2
recursive-include src *.json
recursive-include src *.md
recursive-include src *.py
recursive-include src *.rst
recursive-include src *.typed
recursive-include src *.yaml
recursive-include src *.yamllint
recursive-include src *.yml
recursive-include tools *.sh
recursive-exclude .mypy_cache *.*
recursive-exclude docs/docstree/html *.*
recursive-exclude zuul.d *.*
51 changes: 38 additions & 13 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -1,20 +1,30 @@
[metadata]
name = doc8
summary = Style checker for Sphinx (or other) RST documentation
description_file =
README.rst
url = https://github.com/pycqa/doc8
project_urls =
Bug Tracker = https://github.com/pycqa/doc8/issues
Release Management = https://github.com/pycqa/doc8/releases
CI = https://github.com/pycqa/doc8/actions
Documentation = https://doc8.readthedocs.io
Discussions = https://github.com/pycqa/doc8/discussions

description = Style checker for Sphinx (or other) RST documentation
long_description = file: README.rst
long_description_content_type = text/x-rst
author = OpenStack
author_email = [email protected]
maintainer = PyCQA
maintainer_email = [email protected]
home_page = https://github.com/pycqa/doc8
long_description_content_type = text/x-rst
classifier =
license = Apache 2.0
license_file = LICENSE
classifiers =
Development Status :: 5 - Production/Stable

Environment :: Console

Intended Audience :: Developers
Intended Audience :: Information Technology
Intended Audience :: System Administrators
Intended Audience :: Developers
Development Status :: 4 - Beta
Topic :: Utilities
License :: OSI Approved :: Apache Software License
Operating System :: POSIX :: Linux
Programming Language :: Python
Expand All @@ -24,10 +34,12 @@ classifier =
Programming Language :: Python :: 3.8
Programming Language :: Python :: 3.9
Programming Language :: Python :: 3.10

[entry_points]
console_scripts =
doc8 = doc8.main:main
Topic :: System :: Systems Administration
Topic :: Utilities
keywords =
doc8
rst
linter

[flake8]
builtins = _
Expand All @@ -39,10 +51,23 @@ max_line_length=160
extend_ignore = E203

[options]
use_scm_version = True
python_requires = >=3.6
package_dir =
= src
packages = find:
include_package_data = True
zip_safe = False
# These are required in actual runtime:
install_requires =
docutils
restructuredtext-lint>=0.7
stevedore
Pygments

[options.entry_points]
console_scripts =
doc8 = doc8.main:main

[options.packages.find]
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.
2 changes: 2 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -51,5 +51,7 @@ commands =
pip uninstall -y doc8
# Install the wheel
sh -c "python3 -m pip install {toxinidir}/dist/*.whl"
doc8 --version
python -m doc8 --version
# Ensure package can be uninstalled
pip uninstall -y doc8