diff options
author | David Lord <davidism@gmail.com> | 2021-02-24 10:38:16 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-02-24 10:38:16 -0800 |
commit | 80fc7c6eadd85c83db6b939963bdf304c02997d5 (patch) | |
tree | 9a4d87c3251ff448d9df52e66e5a92c6cdd96f7d | |
parent | 8d53be2a2497137c5d5b12d408a05109b39866e3 (diff) | |
parent | 3af7a3fe497ef732121b5c8d340d248de790f0d7 (diff) | |
download | markupsafe-80fc7c6eadd85c83db6b939963bdf304c02997d5.tar.gz |
Merge pull request #191 from pallets/consistency
various cleanup for consistency between projects
-rw-r--r-- | .github/workflows/tests.yaml | 17 | ||||
-rw-r--r-- | .readthedocs.yaml | 1 | ||||
-rw-r--r-- | MANIFEST.in | 1 | ||||
-rw-r--r-- | README.rst | 21 | ||||
-rw-r--r-- | docs/conf.py | 8 | ||||
-rw-r--r-- | setup.cfg | 35 | ||||
-rw-r--r-- | tox.ini | 2 |
7 files changed, 54 insertions, 31 deletions
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml index 1fd4c3f..d52088f 100644 --- a/.github/workflows/tests.yaml +++ b/.github/workflows/tests.yaml @@ -4,10 +4,18 @@ on: branches: - master - '*.x' + paths-ignore: + - 'docs/**' + - '*.md' + - '*.rst' pull_request: branches: - master - '*.x' + paths-ignore: + - 'docs/**' + - '*.md' + - '*.rst' jobs: tests: name: ${{ matrix.name }} @@ -24,7 +32,6 @@ jobs: - {name: '3.6', python: '3.6', os: ubuntu-latest, tox: py36} - {name: 'PyPy', python: pypy3, os: ubuntu-latest, tox: pypy3} - {name: Typing, python: '3.9', os: ubuntu-latest, tox: typing} - - {name: Docs, python: '3.9', os: ubuntu-latest, tox: docs} steps: - uses: actions/checkout@v2 - uses: actions/setup-python@v2 @@ -39,9 +46,15 @@ jobs: id: pip-cache run: echo "::set-output name=dir::$(pip cache dir)" - name: cache pip - uses: actions/cache@v1 + uses: actions/cache@v2 with: path: ${{ steps.pip-cache.outputs.dir }} key: pip|${{ runner.os }}|${{ matrix.python }}|${{ hashFiles('setup.py') }}|${{ hashFiles('requirements/*.txt') }} + - name: cache mypy + uses: actions/cache@v2 + with: + path: ./.mypy_cache + key: mypy|${{ matrix.python }}|${{ hashFiles('setup.cfg') }} + if: matrix.tox == 'typing' - run: pip install tox - run: tox -e ${{ matrix.tox }} diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 1906952..0c36363 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -6,3 +6,4 @@ python: path: . sphinx: builder: dirhtml + fail_on_warning: true diff --git a/MANIFEST.in b/MANIFEST.in index a3ee780..7dfa3f6 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -5,4 +5,5 @@ graft docs prune docs/_build graft tests include src/markupsafe/py.typed +include src/markupsafe/*.pyi global-exclude *.pyc @@ -49,9 +49,9 @@ Donate ------ The Pallets organization develops and supports MarkupSafe and other -libraries that use it. In order to grow the community of contributors -and users, and allow the maintainers to devote more time to the -projects, `please donate today`_. +popular packages. In order to grow the community of contributors and +users, and allow the maintainers to devote more time to the projects, +`please donate today`_. .. _please donate today: https://palletsprojects.com/donate @@ -59,10 +59,11 @@ projects, `please donate today`_. Links ----- -* Website: https://palletsprojects.com/p/markupsafe/ -* Documentation: https://markupsafe.palletsprojects.com/ -* Releases: https://pypi.org/project/MarkupSafe/ -* Code: https://github.com/pallets/markupsafe -* Issue tracker: https://github.com/pallets/markupsafe/issues -* Test status: https://dev.azure.com/pallets/markupsafe/_build -* Official chat: https://discord.gg/t6rrQZH +- Documentation: https://markupsafe.palletsprojects.com/ +- Changes: https://markupsafe.palletsprojects.com/changes/ +- PyPI Releases: https://pypi.org/project/MarkupSafe/ +- Source Code: https://github.com/pallets/markupsafe/ +- Issue Tracker: https://github.com/pallets/markupsafe/issues/ +- Website: https://palletsprojects.com/p/markupsafe/ +- Twitter: https://twitter.com/PalletsTeam +- Chat: https://discord.gg/pallets diff --git a/docs/conf.py b/docs/conf.py index 881f1ab..102ec7a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -27,11 +27,13 @@ html_theme = "jinja" html_theme_options = {"index_sidebar_logo": False} html_context = { "project_links": [ - ProjectLink("Donate to Pallets", "https://palletsprojects.com/donate"), - ProjectLink("Website", "https://palletsprojects.com/p/markupsafe/"), - ProjectLink("PyPI releases", "https://pypi.org/project/MarkupSafe/"), + ProjectLink("Donate", "https://palletsprojects.com/donate"), + ProjectLink("PyPI Releases", "https://pypi.org/project/MarkupSafe/"), ProjectLink("Source Code", "https://github.com/pallets/markupsafe/"), ProjectLink("Issue Tracker", "https://github.com/pallets/markupsafe/issues/"), + ProjectLink("Website", "https://palletsprojects.com/p/markupsafe/"), + ProjectLink("Twitter", "https://twitter.com/PalletsTeam"), + ProjectLink("Chat", "https://discord.gg/pallets"), ] } html_sidebars = { @@ -3,9 +3,13 @@ name = MarkupSafe version = attr: markupsafe.__version__ url = https://palletsprojects.com/p/markupsafe/ project_urls = + Donate = https://palletsprojects.com/donate Documentation = https://markupsafe.palletsprojects.com/ - Code = https://github.com/pallets/markupsafe - Issue tracker = https://github.com/pallets/markupsafe/issues + Changes = https://markupsafe.palletsprojects.com/changes/ + Source Code = https://github.com/pallets/markupsafe/ + Issue Tracker = https://github.com/pallets/markupsafe/issues/ + Twitter = https://twitter.com/PalletsTeam + Chat = https://discord.gg/pallets license = BSD-3-Clause license_files = LICENSE.rst author = Armin Ronacher @@ -71,16 +75,17 @@ max-line-length = 80 [mypy] files = src/markupsafe -disallow_subclassing_any = true -disallow_untyped_calls = true -disallow_untyped_defs = true -disallow_incomplete_defs = true -no_implicit_optional = true -local_partial_types = true -;no_implicit_reexport = true -strict_equality = true -warn_redundant_casts = true -warn_unused_configs = true -warn_unused_ignores = true -warn_return_any = true -warn_unreachable = true +python_version = 3.6 +disallow_subclassing_any = True +disallow_untyped_calls = True +disallow_untyped_defs = True +disallow_incomplete_defs = True +no_implicit_optional = True +local_partial_types = True +# no_implicit_reexport = True +strict_equality = True +warn_redundant_casts = True +warn_unused_configs = True +warn_unused_ignores = True +warn_return_any = True +warn_unreachable = True @@ -8,7 +8,7 @@ skip_missing_interpreters = true [testenv] deps = -r requirements/tests.txt -commands = pytest --tb=short --basetemp={envtmpdir} {posargs} +commands = pytest -v --tb=short --basetemp={envtmpdir} {posargs} [testenv:style] deps = pre-commit |