Docs should link back to PyPI or Github project #77

jaraco · 2023-04-10T14:23:04Z

If someone is directed at the docs for a project, there's no good link back to the project. RTD does provide a link back to the Github source for that page, which indirectly links to the Github project. Better would be for there to be a link to the PyPI project near the top of the page. Can this be accomplished in a generic way (that applies to all projects)?

jaraco · 2023-07-05T17:07:09Z

The jaraco.packaging project already configures the project_url. It seems to me that should be sufficient for the docs to provide a link to the project. Perhaps there's a Sphinx directive that would present that link.

jaraco · 2023-07-05T17:11:34Z

Hmm. I don't see any reference to 'project_url' in the sphinx docs, making me think that attribute setting has no effect other than setting that attribute on the config. Probably there needs to be some way to plumb that into the docs.

jaraco · 2023-07-06T00:42:04Z

After trying to use substitutions and extlinks with little luck, I stumbled on sidebar_links, which is designed to do exactly what I want except that it requires the details to be hard-coded. But maybe jaraco.packaging could copy or re-use some of that toolbox to generate those from the package metadata.

….12.0 to version 6.0.0 Jason R. Coombs (22): Remove unnecessary and incorrect copyright notice. Fixes jaraco/skeleton#78. Replace flake8 with ruff. Fixes jaraco/skeleton#79 and sheds debt. Make substitution fields more prominent and distinct from true 'skeleton' references. (#71) Suppress EncodingWarning in build.env. Ref pypa/build#615. Remove reference to EncodingWarning as it doesn't exist on some Pythons. Update RTD boilerplate to new issue. Ref readthedocs/readthedocs.org#10401. Add badge for Ruff. Remove inclusion of python version for docs Adopt towncrier for managing changelog. Fixes jaraco/skeleton#83. Replace workaround for actions/setup-python#508 with 'allow-prereleases' Remove tox boilerplate, no longer necessary with later versions of tox. Require Python 3.8 or later. Expand 'finalize' to commit and tag the change. Leverage pytest-enabler 2.2 for the default config. Prefer 3.x for Python version (latest stable). Collapse skeleton history. Workaround for jaraco/skeleton#87. Add links to project home page and pypi. Fixes jaraco/skeleton#77. Replace redundant step names with simple 'Run'. Finalize Remove legacy support. Fixes #80. Update Python version mapping to include Python 3.13 and updates to 3.12 per python/cpython#97930. Finalize Joyce (1): Feat: initial permissions to main.yml (jaraco/skeleton#76)

…n 3.16.0 Jason R. Coombs (22): zipp 3.15 is now in Python 3.12. Remove unnecessary and incorrect copyright notice. Fixes jaraco/skeleton#78. Replace flake8 with ruff. Fixes jaraco/skeleton#79 and sheds debt. Make substitution fields more prominent and distinct from true 'skeleton' references. (#71) Suppress EncodingWarning in build.env. Ref pypa/build#615. Remove reference to EncodingWarning as it doesn't exist on some Pythons. Update RTD boilerplate to new issue. Ref readthedocs/readthedocs.org#10401. Add badge for Ruff. Remove inclusion of python version for docs Adopt towncrier for managing changelog. Fixes jaraco/skeleton#83. Replace workaround for actions/setup-python#508 with 'allow-prereleases' Remove tox boilerplate, no longer necessary with later versions of tox. Require Python 3.8 or later. Expand 'finalize' to commit and tag the change. Leverage pytest-enabler 2.2 for the default config. Prefer 3.x for Python version (latest stable). Collapse skeleton history. Workaround for jaraco/skeleton#87. Add links to project home page and pypi. Fixes jaraco/skeleton#77. Replace redundant step names with simple 'Run'. Increase visibility of security policy. (#4) Remove Python 3.7 compatibility from py310compat Finalize Joyce (1): Feat: initial permissions to main.yml (jaraco/skeleton#76)

… version 6.0.0 Jason R. Coombs (61): Add PyPy to the test matrix on Linux. Fixes jaraco/skeleton#63. When rendering docs, preserve the syntax for defaults. Fixes jaraco/path#197. Adopt furo theme for docs. Indicate to use latest Python version (workaround for readthedocs/readthedocs.org/#9623). Requires also specifying the OS version (workaround for readthedocs/readthedocs.org#9635). GHA pretty env (#67) Pin mypy to '<0.990' due to realpython/pytest-mypy#141 Remove the hyperlink for the Python versions badge. The PyPI badge is a better anchor for the hyperlink. Apply explicit_package_bases for mypy and unpin the version. Ref python/mypy#14057. Add Python 3.12 to matrix. Only test 3.8-3.10 on Linux. Disable flake8 on Python 3.12. Workaround for tholo/pytest-flake8#87. Honor ResourceWarnings. Fixes jaraco/skeleton#73. tox 4 requires a boolean value, so use '1' to FORCE_COLOR. Fixes jaraco/skeleton#74. Remove unnecessary shebang and encoding header in docs conf. Prevent Python 3.12 from blocking checks. Run tests on Windows again. Fixes #58. Exclude Python 3.7 + Windows from the matrix as permanent workaround for #58. Build docs in CI, including sphinx-lint. Put tidelift docs dependency in its own section to limit merge conflicts. Remove 'configparser' as that renders the stdlib docs. Update badge for 2023 ALLOW_UNICODE no longer needed on Python 3. As a result, ELLIPSES is also now enabled by default. Enable default encoding warning where available. See PEP 597. Suppress EncodingWarning in pytest_black. Workaround for shopkeep/pytest-black#67. Exempt warning. Workaround for realpython/pytest-mypy#152 Add #upstream markers for filtered warnings. Add filter for platform module (ref python/cpython#100750). Remove reference to EncodingWarning as it doesn't exist on some Pythons. Revert "exclude build env from cov reporting (jaraco/skeleton#60)" Disable couldnt-parse warnings. Prescribed workaround for nedbat/coveragepy#1392. Fixes python/importlib_resources#279 and fixes jaraco/skeleton#56. ⚫ Fade to black. Remove unnecessary and incorrect copyright notice. Fixes jaraco/skeleton#78. Replace flake8 with ruff. Fixes jaraco/skeleton#79 and sheds debt. Make substitution fields more prominent and distinct from true 'skeleton' references. (#71) Suppress EncodingWarning in build.env. Ref pypa/build#615. Remove reference to EncodingWarning as it doesn't exist on some Pythons. Update RTD boilerplate to new issue. Ref readthedocs/readthedocs.org#10401. Add badge for Ruff. Remove inclusion of python version for docs Adopt towncrier for managing changelog. Fixes jaraco/skeleton#83. Replace workaround for actions/setup-python#508 with 'allow-prereleases' Remove tox boilerplate, no longer necessary with later versions of tox. Require Python 3.8 or later. Expand 'finalize' to commit and tag the change. Leverage pytest-enabler 2.2 for the default config. Prefer 3.x for Python version (latest stable). Collapse skeleton history. Workaround for jaraco/skeleton#87. Add links to project home page and pypi. Fixes jaraco/skeleton#77. Replace redundant step names with simple 'Run'. Increase visibility of security policy. (#4) Normalized headings in readme. 👹 Feed the hobgoblins (delint). Bump exclusion to Python 3.8 now that Windows tests run there. Closes #67. Restore Windows tests on older Pythons (#68) Comment out just the option. cpython-v3.12.0b3 rev=f992a60014b7 Apply pyupgrade for Python 3.8+ to test_backport. Move tests out of the package. Move package out of src Re-enable doctests now that pytest-dev/pytest#3396 is solved. Remove legacy support in configparser module. Skip unimportant coverage checks Finalize Joyce (1): Feat: initial permissions to main.yml (jaraco/skeleton#76) Zach Burnett (1): rename `.readthedocs.yml` to `.readthedocs.yaml` (RTD docs indicate that `.readthedocs.yml` will be deprecated) (#68)

…to version 3.3.0 Jason R. Coombs (43): Adopt furo theme for docs. Indicate to use latest Python version (workaround for readthedocs/readthedocs.org/#9623). Requires also specifying the OS version (workaround for readthedocs/readthedocs.org#9635). GHA pretty env (#67) Pin mypy to '<0.990' due to realpython/pytest-mypy#141 Remove the hyperlink for the Python versions badge. The PyPI badge is a better anchor for the hyperlink. Apply explicit_package_bases for mypy and unpin the version. Ref python/mypy#14057. Add Python 3.12 to matrix. Only test 3.8-3.10 on Linux. Disable flake8 on Python 3.12. Workaround for tholo/pytest-flake8#87. Honor ResourceWarnings. Fixes jaraco/skeleton#73. tox 4 requires a boolean value, so use '1' to FORCE_COLOR. Fixes jaraco/skeleton#74. Remove unnecessary shebang and encoding header in docs conf. Prevent Python 3.12 from blocking checks. Build docs in CI, including sphinx-lint. Put tidelift docs dependency in its own section to limit merge conflicts. Update badge for 2023 ALLOW_UNICODE no longer needed on Python 3. As a result, ELLIPSES is also now enabled by default. Enable default encoding warning where available. See PEP 597. Suppress EncodingWarning in pytest_black. Workaround for shopkeep/pytest-black#67. Exempt warning. Workaround for realpython/pytest-mypy#152 Add #upstream markers for filtered warnings. Add filter for platform module (ref python/cpython#100750). Remove reference to EncodingWarning as it doesn't exist on some Pythons. Revert "exclude build env from cov reporting (jaraco/skeleton#60)" Disable couldnt-parse warnings. Prescribed workaround for nedbat/coveragepy#1392. Fixes python/importlib_resources#279 and fixes jaraco/skeleton#56. Remove unnecessary and incorrect copyright notice. Fixes jaraco/skeleton#78. Replace flake8 with ruff. Fixes jaraco/skeleton#79 and sheds debt. Make substitution fields more prominent and distinct from true 'skeleton' references. (#71) Suppress EncodingWarning in build.env. Ref pypa/build#615. Remove reference to EncodingWarning as it doesn't exist on some Pythons. Update RTD boilerplate to new issue. Ref readthedocs/readthedocs.org#10401. Add badge for Ruff. Remove inclusion of python version for docs Adopt towncrier for managing changelog. Fixes jaraco/skeleton#83. Replace workaround for actions/setup-python#508 with 'allow-prereleases' Remove tox boilerplate, no longer necessary with later versions of tox. Require Python 3.8 or later. Expand 'finalize' to commit and tag the change. Leverage pytest-enabler 2.2 for the default config. Prefer 3.x for Python version (latest stable). Collapse skeleton history. Workaround for jaraco/skeleton#87. Add links to project home page and pypi. Fixes jaraco/skeleton#77. Replace redundant step names with simple 'Run'. Increase visibility of security policy. (#4) Finalize Joyce (1): Feat: initial permissions to main.yml (jaraco/skeleton#76) Zach Burnett (1): rename `.readthedocs.yml` to `.readthedocs.yaml` (RTD docs indicate that `.readthedocs.yml` will be deprecated) (#68)

…0 to version 3.8.1 Jason R. Coombs (10): Leverage pytest-enabler 2.2 for the default config. Prefer 3.x for Python version (latest stable). Collapse skeleton history. Workaround for jaraco/skeleton#87. Add links to project home page and pypi. Fixes jaraco/skeleton#77. Replace redundant step names with simple 'Run'. Increase visibility of security policy. (#4) Remove TOX_WORK_DIR workaround, no longer necessary with tox 4. Ref tox-dev/tox#3050. Restore type ignorance repairing linter mangling. Restore mypy; import-mode importlib is working. Ref pytest-dev/pytest#8332 Finalize

…version 68.1.0 Anderson Bravalheri (46): Remove dependency on `pip-run`. Avoid pytest-perf on Cygwin Rewrite noqa directive for the bennefit of ruff Add workaround for towncrier Revert changes in _EditableFinder Reuse PathFinder to deal with fs case sensitivity in editable_wheel Add more checks for case sensitivity in editable_wheel tests Adequate tests to the latest changes in wheel 0.41.1 Allow SystemExit exceptions to pass through unless code = 0 Remove leftover variable in test_build_meta Test setup.py with sys.exit(0) only for non-legacy backend Remove unused import Exclude __pycache__ and pyc files in MANIFEST.in Exclude newsfragments and launcher directories from find_packages Ignore newsfragments by default when auto-discovering flat packages Add newsfragment Fix rst syntax in newsfragment Use default encoding when creating .pth files in editable_wheel Add newsfragment Change UTF-8 example to something simpler to parse Add regression tests for sdist Simplify handling of relative ext.depends Update changelog entry Change classification of PR from bugfix to feature Improve logic operations on path handling Use 'resolve' instead of 'abspath' Add test for auto inclusion of depends in the case of symlinks Allow symlinked Extension.depends to be auto-included by sdist Add test case for when dependency files don't exit Capture expectation about (gui-)scripts in pyproject.toml/setup.py Make sure user is notified that (gui-)scripts have to be defined in dynamic Add news fragment Remove beta warning for pyproject tool.setuptools Update docs to remove beta status for tool.setuptools Remove unused import Mention setup.py install for zip-safe and eager-resources Prefer the obsolete nomenclature Retain warning for tool.distutils (still internal/experimental) Retouch pyproject config docs Add news fragment Ignore warnings about tool.distutils Remove confusing bit of doc Refactor TestRegressions to use symlink_or_skip_test Fix tools/finalize to use NEWS instead of CHANGES (towncrier-related) Improve rendering of newsfragment Bump version: 68.0.0 → 68.1.0 Arcadiy Ivanov (1): Handle `setup.py` possibly using `sys.exit` Ashley Anderson (11): Fix sphinx-lint errors in docs Add failing test Update _EditableFinder (in _FINDER_TEMPLATE) to be case-sensitive on case-insensitive filesystems Add news fragment Remove redundant logic Ensure posix paths to enforce case-sensitivity on Windows Expand case-sensitivity tests More robust checking of path case for imports from editable installations Move _check_case within the template Fix for Python <3.10 Small refactor to fix off-by-one, lint Bart Broere (1): Fix a sentence (minor change) Dimitri Papadopoulos (1): Fix a couple typos found by codespell Hang (2): Update package_discovery.rst Update package_discovery.rst Jason R. Coombs (29): Adopt towncrier for managing changelog. Fixes jaraco/skeleton#83. ⚫ Fade to black. Use a different variable name. Fixes #3961. Workaround for astral-sh/ruff#5249. Move towncrier config to its own file. Use the default 'newsfragments' for news fragments. Use jaraco.develop.towncrier to check changes and determine the release kind. Revert to towncrier default types. Normalized headings in changelog. Remove excess config Add newsfragment Exclude jaraco.develop on cygwin Remove code reliant on bdist_wininst. Ref #3525. Replace workaround for actions/setup-python#508 with 'allow-prereleases' Remove tox boilerplate, no longer necessary with later versions of tox. Require Python 3.8 or later. Expand 'finalize' to commit and tag the change. Leverage pytest-enabler 2.2 for the default config. Update config to honor black. Apply black styling to all but vendored modules. Manually correct line too long errors. Grab workaround for pytest-dev/execnet#195. Rely on unreleased build. Workaround for pypa/build#630. Move workarounds to tox.ini to avoid url references in project metadata. Prefer 3.x for Python version (latest stable). Collapse skeleton history. Workaround for jaraco/skeleton#87. Add links to project home page and pypi. Fixes jaraco/skeleton#77. Replace redundant step names with simple 'Run'. Increase visibility of security policy. (#4) Remove TOX_WORK_DIR workaround, no longer necessary with tox 4. Ref tox-dev/tox#3050. Joyce (4): Feat: set ci-sage.yml top level as contents read feat: initial permissions to main.yml Create 3833.misc.rst Add user to changelog.d file. Oliver Mannion (1): docs: remove mention of include_package_data and package_data interaction Stefano Rivera (4): Exclude debian dirs from the default namespace search Exclude "debian" from top_level.txt. A news fragment Explain where we are ignoring Debian Thomas Kluyver (1): Remove execnet workaround ruro (14): add Extension.depends to build_ext.get_source_files add tests for Extension sdist handling add news fragment for PR improve backwards compatibility and warning messages remove test_auto_include_symlinked_depends reimplement _get_internal_depends according to the new logic remove no longer used functions in _path refactor the tests a bit move test project root to subdir, use source_dir fixture improve the touch helper function add test_symlinked_extension_sources add test_invalid_extension_depends inline is_relative_to (it's not available in Python 3.8) don't run logging verification tests under stdlib distutils wim glenn (1): Typo fix pyproject_config.rst

…sion 24.3.0 Jason R. Coombs (22): Finalize Extract config_path fixture. Reduces nesting and re-uses behavior. Leverage pytest-enabler 2.2 for the default config. Prefer 3.x for Python version (latest stable). Collapse skeleton history. Workaround for jaraco/skeleton#87. Add links to project home page and pypi. Fixes jaraco/skeleton#77. Replace redundant step names with simple 'Run'. Increase visibility of security policy. (#4) Remove TOX_WORK_DIR workaround, no longer necessary with tox 4. Ref tox-dev/tox#3050. Rephrase the error to more generically refer to the 'executable', which may not be Python. Ref #629. Pin against sphinx 7.2.5 as workaround for sphinx/sphinx-doc#11662. Closes jaraco/skeleton#88. Allow GITHUB_* settings to pass through to tests. Remove spinner disablement. If it's not already fixed upstream, that's where it should be fixed. Clean up 'color' environment variables. Add diff-cover check to Github Actions CI. Closes jaraco/skeleton#90. Add descriptions to the tox environments. Closes jaraco/skeleton#91. Add FORCE_COLOR to the TOX_OVERRIDE for GHA. Requires tox 4.11.1. Closes jaraco/skeleton#89. Prefer ``pass_env`` in tox config. Preferred failure mode for tox-dev/tox#3127 and closes jaraco/skeleton#92. Limit sphinxlint jobs to 1. Workaround for sphinx-contrib/sphinx-lint#83. Add news fragment. Disable type checking on filter call. Fixes #659. Finalize Matěj Cepl (1): Add mention of keyring_pass.PasswordStoreBackend Ville Skyttä (4): Spelling and grammar fixes Remove version from bitwarden-keyring PyPI link Fix `--keyring-path` and `--keyring-backend` completions Add `--keyring-backend` argument completion for bash falling-springs (1): Add onepassword-keyring to the external backends

… version 3.12.0 Jason R. Coombs (35): Add #upstream markers for filtered warnings. Add filter for platform module (ref python/cpython#100750). Remove reference to EncodingWarning as it doesn't exist on some Pythons. Revert "exclude build env from cov reporting (jaraco/skeleton#60)" Disable couldnt-parse warnings. Prescribed workaround for nedbat/coveragepy#1392. Fixes python/importlib_resources#279 and fixes jaraco/skeleton#56. Remove unnecessary and incorrect copyright notice. Fixes jaraco/skeleton#78. Replace flake8 with ruff. Fixes jaraco/skeleton#79 and sheds debt. Make substitution fields more prominent and distinct from true 'skeleton' references. (#71) Suppress EncodingWarning in build.env. Ref pypa/build#615. Remove reference to EncodingWarning as it doesn't exist on some Pythons. Update RTD boilerplate to new issue. Ref readthedocs/readthedocs.org#10401. Add badge for Ruff. Remove inclusion of python version for docs Adopt towncrier for managing changelog. Fixes jaraco/skeleton#83. Replace workaround for actions/setup-python#508 with 'allow-prereleases' Remove tox boilerplate, no longer necessary with later versions of tox. Require Python 3.8 or later. Expand 'finalize' to commit and tag the change. Leverage pytest-enabler 2.2 for the default config. Prefer 3.x for Python version (latest stable). Collapse skeleton history. Workaround for jaraco/skeleton#87. Add links to project home page and pypi. Fixes jaraco/skeleton#77. Replace redundant step names with simple 'Run'. Increase visibility of security policy. (#4) Remove TOX_WORK_DIR workaround, no longer necessary with tox 4. Ref tox-dev/tox#3050. Pin against sphinx 7.2.5 as workaround for sphinx/sphinx-doc#11662. Closes jaraco/skeleton#88. Allow GITHUB_* settings to pass through to tests. Remove spinner disablement. If it's not already fixed upstream, that's where it should be fixed. Clean up 'color' environment variables. Add diff-cover check to Github Actions CI. Closes jaraco/skeleton#90. Add descriptions to the tox environments. Closes jaraco/skeleton#91. Add FORCE_COLOR to the TOX_OVERRIDE for GHA. Requires tox 4.11.1. Closes jaraco/skeleton#89. Prefer ``pass_env`` in tox config. Preferred failure mode for tox-dev/tox#3127 and closes jaraco/skeleton#92. Limit sphinxlint jobs to 1. Workaround for sphinx-contrib/sphinx-lint#83. Update for Python 3.8+ Finalize Joyce (1): Feat: initial permissions to main.yml (jaraco/skeleton#76)

…8.0 to version 7.0.0 Amund Hov (1): With commit 0c819641d314ac496eb32b55f2b15215fa6fa55f the behavior of Entrypoints gets a bit disorienting. Christian Clauss (2): Upgrade GitHub Actions checkout (jaraco/skeleton#94) GitHub Actions: Combine tox jobs diffcov and docs (jaraco/skeleton#95) Dimitri Papadopoulos (1): Fix new typo found using codespell Jason R. Coombs (30): Add links to project home page and pypi. Fixes jaraco/skeleton#77. Replace redundant step names with simple 'Run'. Increase visibility of security policy. (#4) Remove TOX_WORK_DIR workaround, no longer necessary with tox 4. Ref tox-dev/tox#3050. Add origin property. Ref #404. Pin against sphinx 7.2.5 as workaround for sphinx/sphinx-doc#11662. Closes jaraco/skeleton#88. Allow GITHUB_* settings to pass through to tests. Remove spinner disablement. If it's not already fixed upstream, that's where it should be fixed. Clean up 'color' environment variables. Add diff-cover check to Github Actions CI. Closes jaraco/skeleton#90. Add descriptions to the tox environments. Closes jaraco/skeleton#91. Add FORCE_COLOR to the TOX_OVERRIDE for GHA. Requires tox 4.11.1. Closes jaraco/skeleton#89. Prefer ``pass_env`` in tox config. Preferred failure mode for tox-dev/tox#3127 and closes jaraco/skeleton#92. Update changelog to reflect backward-incompatible effect. Ref #459. Limit sphinxlint jobs to 1. Workaround for sphinx-contrib/sphinx-lint#83. Remove news fragment after allowing time to be processed downstream. Suppress deprecation warning in dateutil. Workaround for dateutil/dateutil#1284. ⚫ Fade to black. 🧎‍♀️ Genuflect to the types. Add news fragment. Intended for #473. Finalize Added diagnose script. Closes #461. Finalize Restore pypy tests now that 3.10 is the standard. Bypasses issue in #463. Add changelog Add test capturing expectation. Ref #404 Use a SiteBuilder class to build files in the site, traversing the class hierarchy explicitly and avoiding the need for separate setUp calls for each. Finalize Removed EntryPoint access by numeric index (tuple behavior). Finalize

…3.0 to version 5.0.0 Christian Clauss (2): Upgrade GitHub Actions checkout (jaraco/skeleton#94) GitHub Actions: Combine tox jobs diffcov and docs (jaraco/skeleton#95) Jason R. Coombs (24): Leverage pytest-enabler 2.2 for the default config. Prefer 3.x for Python version (latest stable). Collapse skeleton history. Workaround for jaraco/skeleton#87. Add links to project home page and pypi. Fixes jaraco/skeleton#77. Replace redundant step names with simple 'Run'. Increase visibility of security policy. (#4) Remove TOX_WORK_DIR workaround, no longer necessary with tox 4. Ref tox-dev/tox#3050. Pin against sphinx 7.2.5 as workaround for sphinx/sphinx-doc#11662. Closes jaraco/skeleton#88. Allow GITHUB_* settings to pass through to tests. Remove spinner disablement. If it's not already fixed upstream, that's where it should be fixed. Clean up 'color' environment variables. Add diff-cover check to Github Actions CI. Closes jaraco/skeleton#90. Add descriptions to the tox environments. Closes jaraco/skeleton#91. Add FORCE_COLOR to the TOX_OVERRIDE for GHA. Requires tox 4.11.1. Closes jaraco/skeleton#89. Prefer ``pass_env`` in tox config. Preferred failure mode for tox-dev/tox#3127 and closes jaraco/skeleton#92. Limit sphinxlint jobs to 1. Workaround for sphinx-contrib/sphinx-lint#83. Remove news fragment after allowing time to be processed downstream. Suppress deprecation warning in dateutil. Workaround for dateutil/dateutil#1284. Update Github Actions badge per actions/starter-workflows#1525. Simplify docstring and tests for dict_map Removed DictFilter. Use proper reference for Projection. Moved collections into a package and declared as typed. Finalize

…ion 5.5.1 Bartosz Sławecki (1): Tweak coverage configuration for type checking (jaraco/skeleton#97) Christian Clauss (2): Upgrade GitHub Actions checkout (jaraco/skeleton#94) GitHub Actions: Combine tox jobs diffcov and docs (jaraco/skeleton#95) Dimitri Papadopoulos Orfanos (2): Use the ruff formatter (jaraco/skeleton#99) ruff: extended-ignore → ignore (jaraco/skeleton#105) Jason R. Coombs (35): Sort imports and remove redundant import. Clean up docstring on Stopwatch Prefer 3.x for Python version (latest stable). Collapse skeleton history. Workaround for jaraco/skeleton#87. Add links to project home page and pypi. Fixes jaraco/skeleton#77. Replace redundant step names with simple 'Run'. Increase visibility of security policy. (#4) Remove TOX_WORK_DIR workaround, no longer necessary with tox 4. Ref tox-dev/tox#3050. Pin against sphinx 7.2.5 as workaround for sphinx/sphinx-doc#11662. Closes jaraco/skeleton#88. Allow GITHUB_* settings to pass through to tests. Remove spinner disablement. If it's not already fixed upstream, that's where it should be fixed. Clean up 'color' environment variables. Add diff-cover check to Github Actions CI. Closes jaraco/skeleton#90. Add descriptions to the tox environments. Closes jaraco/skeleton#91. Add FORCE_COLOR to the TOX_OVERRIDE for GHA. Requires tox 4.11.1. Closes jaraco/skeleton#89. Prefer ``pass_env`` in tox config. Preferred failure mode for tox-dev/tox#3127 and closes jaraco/skeleton#92. Limit sphinxlint jobs to 1. Workaround for sphinx-contrib/sphinx-lint#83. Remove news fragment after allowing time to be processed downstream. Suppress deprecation warning in freezegun. Workaround for spulec/freezegun#508 Suppress deprecation warning in dateutil. Workaround for dateutil/dateutil#1284. Update Github Actions badge per actions/starter-workflows#1525. Separate collateral jobs on different lines for easier override/extension. Drop minimum requirement on pytest-mypy as most environments are already running much later. Closes jaraco/skeleton#96. Remove sole entry for branches-ignore. Workaround for and closes jaraco/skeleton#103. Bump year on badge Remove build and dist from excludes. It appears they are not needed and their presence blocks the names of packages like 'builder' and 'distutils'. Ref pypa/distutils#224. Exclude docs and tests directories properly per Setuptools behavior. Rely on default discovery for good heuristics for finding packages. Enable preview to enable preserving quotes. Use latest versions in RTD boilerplate. Remove Sphinx pin. Ref sphinx-doc/sphinx#11662. Include deps from the base config in diffcov. 👹 Feed the hobgoblins (delint). Remove test dependency on backports.unittest_mock. Closes #26. Finalize Sviatoslav Sydorenko (1): Enable testing merge queues @ GitHub Actions CI/CD (jaraco/skeleton#93)

…ion 7.2.0 Anderson Bravalheri (7): Replace pydantic...validate_call with typeguard.typecheck Use a metaclass for Word Replace same_method with regular comparisson Fix black error Remove pydantic imports Remove pydantic compatibility modules Remove dependency on pydantic Avasam (1): Allow mypy on PyPy (jaraco/skeleton#111) Bartosz Sławecki (1): Tweak coverage configuration for type checking (jaraco/skeleton#97) Christian Clauss (2): Upgrade GitHub Actions checkout (jaraco/skeleton#94) GitHub Actions: Combine tox jobs diffcov and docs (jaraco/skeleton#95) Dimitri Papadopoulos Orfanos (2): Use the ruff formatter (jaraco/skeleton#99) ruff: extended-ignore → ignore (jaraco/skeleton#105) James Addison (1): Revert "Remove copyright - copyright is automatic and based on history in version control." Jason R. Coombs (57): Prefer 3.x for Python version (latest stable). Collapse skeleton history. Workaround for jaraco/skeleton#87. Limit the workaround to the Pydantic 2.0.0.0 release. Add links to project home page and pypi. Fixes jaraco/skeleton#77. Replace redundant step names with simple 'Run'. Increase visibility of security policy. (#4) Remove TOX_WORK_DIR workaround, no longer necessary with tox 4. Ref tox-dev/tox#3050. Add changelog Finalize 🧎‍♀️ Genuflect to the types. Refactor to have a single return expression. Remove check on word length (unused). Use windowed_complete to iterate over the windowed words. Rename 'function' to 'inflection' for precision. Remove noqa C901 now that the function is simpler. Pin against sphinx 7.2.5 as workaround for sphinx/sphinx-doc#11662. Closes jaraco/skeleton#88. Allow GITHUB_* settings to pass through to tests. Remove spinner disablement. If it's not already fixed upstream, that's where it should be fixed. Clean up 'color' environment variables. Add diff-cover check to Github Actions CI. Closes jaraco/skeleton#90. Add descriptions to the tox environments. Closes jaraco/skeleton#91. Add FORCE_COLOR to the TOX_OVERRIDE for GHA. Requires tox 4.11.1. Closes jaraco/skeleton#89. Prefer ``pass_env`` in tox config. Preferred failure mode for tox-dev/tox#3127 and closes jaraco/skeleton#92. Limit sphinxlint jobs to 1. Workaround for sphinx-contrib/sphinx-lint#83. Remove news fragment after allowing time to be processed downstream. Suppress deprecation warning in dateutil. Workaround for dateutil/dateutil#1284. Update Github Actions badge per actions/starter-workflows#1525. Separate collateral jobs on different lines for easier override/extension. Drop minimum requirement on pytest-mypy as most environments are already running much later. Closes jaraco/skeleton#96. Remove sole entry for branches-ignore. Workaround for and closes jaraco/skeleton#103. Bump year on badge Remove build and dist from excludes. It appears they are not needed and their presence blocks the names of packages like 'builder' and 'distutils'. Ref pypa/distutils#224. Exclude docs and tests directories properly per Setuptools behavior. Rely on default discovery for good heuristics for finding packages. Enable preview to enable preserving quotes. Use latest versions in RTD boilerplate. Remove Sphinx pin. Ref sphinx-doc/sphinx#11662. Include deps from the base config in diffcov. Registering project with tea. Enable complexity check and pycodestyle warnings. Closes jaraco/skeleton#110. Use 'extend-select' to avoid disabling the default config. Ref jaraco/skeleton#110. Re-enable ignoring of temporary merge queue branches. Closes jaraco/skeleton#103. Fetch unshallow clones in readthedocs. Closes jaraco/skeleton#114. Move Python 3.11 out of the test matrix. 👹 Feed the hobgoblins (delint). One more level deep, pydantic now inflects the error message. 👹 Feed the hobgoblins (delint). Prefer f-strings 👹 Feed the hobgoblins (delint). Catch more specific exception (B017). 👹 Feed the hobgoblins (delint). Fix pointless comparison (B015). 👹 Feed the hobgoblins (delint). 👹 Feed the hobgoblins (delint). Add news fragment. Mark type checking block as uncovered. Finalize Paul (7): Handle "pair of ..." when word in `pl_sb_uninflected_complete` "octopi" as plural form for "octopus" Reverted "octopi" Reverted "syringe" test Created function Added examples to `_handle_long_compounds` Use `noqa: C901` Sviatoslav Sydorenko (1): Enable testing merge queues @ GitHub Actions CI/CD (jaraco/skeleton#93)

…to version 5.1.0 Avasam (1): Allow mypy on PyPy (jaraco/skeleton#111) Bartosz Sławecki (1): Tweak coverage configuration for type checking (jaraco/skeleton#97) Christian Clauss (2): Upgrade GitHub Actions checkout (jaraco/skeleton#94) GitHub Actions: Combine tox jobs diffcov and docs (jaraco/skeleton#95) Dimitri Papadopoulos Orfanos (2): Use the ruff formatter (jaraco/skeleton#99) ruff: extended-ignore → ignore (jaraco/skeleton#105) Jason R. Coombs (71): ALLOW_UNICODE no longer needed on Python 3. As a result, ELLIPSES is also now enabled by default. Enable default encoding warning where available. See PEP 597. Suppress EncodingWarning in pytest_black. Workaround for shopkeep/pytest-black#67. Exempt warning. Workaround for realpython/pytest-mypy#152 Add #upstream markers for filtered warnings. Add filter for platform module (ref python/cpython#100750). Remove reference to EncodingWarning as it doesn't exist on some Pythons. Revert "exclude build env from cov reporting (jaraco/skeleton#60)" Disable couldnt-parse warnings. Prescribed workaround for nedbat/coveragepy#1392. Fixes python/importlib_resources#279 and fixes jaraco/skeleton#56. Remove unnecessary and incorrect copyright notice. Fixes jaraco/skeleton#78. Replace flake8 with ruff. Fixes jaraco/skeleton#79 and sheds debt. Make substitution fields more prominent and distinct from true 'skeleton' references. (#71) Suppress EncodingWarning in build.env. Ref pypa/build#615. Remove reference to EncodingWarning as it doesn't exist on some Pythons. Update RTD boilerplate to new issue. Ref readthedocs/readthedocs.org#10401. Add badge for Ruff. Remove inclusion of python version for docs Adopt towncrier for managing changelog. Fixes jaraco/skeleton#83. Replace workaround for actions/setup-python#508 with 'allow-prereleases' Remove tox boilerplate, no longer necessary with later versions of tox. Require Python 3.8 or later. Expand 'finalize' to commit and tag the change. Leverage pytest-enabler 2.2 for the default config. Prefer 3.x for Python version (latest stable). Collapse skeleton history. Workaround for jaraco/skeleton#87. Add links to project home page and pypi. Fixes jaraco/skeleton#77. Replace redundant step names with simple 'Run'. Increase visibility of security policy. (#4) Remove TOX_WORK_DIR workaround, no longer necessary with tox 4. Ref tox-dev/tox#3050. Pin against sphinx 7.2.5 as workaround for sphinx/sphinx-doc#11662. Closes jaraco/skeleton#88. Allow GITHUB_* settings to pass through to tests. Remove spinner disablement. If it's not already fixed upstream, that's where it should be fixed. Clean up 'color' environment variables. Add diff-cover check to Github Actions CI. Closes jaraco/skeleton#90. Add descriptions to the tox environments. Closes jaraco/skeleton#91. Add FORCE_COLOR to the TOX_OVERRIDE for GHA. Requires tox 4.11.1. Closes jaraco/skeleton#89. Prefer ``pass_env`` in tox config. Preferred failure mode for tox-dev/tox#3127 and closes jaraco/skeleton#92. Limit sphinxlint jobs to 1. Workaround for sphinx-contrib/sphinx-lint#83. Remove news fragment after allowing time to be processed downstream. Suppress deprecation warning in dateutil. Workaround for dateutil/dateutil#1284. Update Github Actions badge per actions/starter-workflows#1525. Separate collateral jobs on different lines for easier override/extension. Drop minimum requirement on pytest-mypy as most environments are already running much later. Closes jaraco/skeleton#96. Remove sole entry for branches-ignore. Workaround for and closes jaraco/skeleton#103. Bump year on badge Remove build and dist from excludes. It appears they are not needed and their presence blocks the names of packages like 'builder' and 'distutils'. Ref pypa/distutils#224. Exclude docs and tests directories properly per Setuptools behavior. Rely on default discovery for good heuristics for finding packages. Enable preview to enable preserving quotes. Use latest versions in RTD boilerplate. Remove Sphinx pin. Ref sphinx-doc/sphinx#11662. Include deps from the base config in diffcov. Enable complexity check and pycodestyle warnings. Closes jaraco/skeleton#110. Use 'extend-select' to avoid disabling the default config. Ref jaraco/skeleton#110. Re-enable ignoring of temporary merge queue branches. Closes jaraco/skeleton#103. Fetch unshallow clones in readthedocs. Closes jaraco/skeleton#114. Move Python 3.11 out of the test matrix. Configure pytest to support namespace packages. Ref pytest-dev/pytest#12112. Update readme and docs. 👹 Feed the hobgoblins (delint). 👹 Feed the hobgoblins (delint). Removed deprecated 'runner' parameter to tarball_context. Renamed tarball_context to tarball and deprecated tarball_context compatibility shim. Disentangle pushd from tarball. Add a few type hints. Ref #2 Finalize 👹 Feed the hobgoblins (delint). Implement compose for composing context managers. Make the function private for now, available experimentally until there's feedback (or not) on the approach. Deprecate null context. Rely on Python 3.8 syntax. Finalize Joyce (1): Feat: initial permissions to main.yml (jaraco/skeleton#76) Sviatoslav Sydorenko (1): Enable testing merge queues @ GitHub Actions CI/CD (jaraco/skeleton#93)

jaraco added a commit to jaraco/jaraco.packaging that referenced this issue Jul 6, 2023

Add support for sidebar-links directive. Ref jaraco/skeleton#77.

a223564

jaraco added a commit to jaraco/jaraco.packaging that referenced this issue Jul 6, 2023

Add support for sidebar-links directive. Ref jaraco/skeleton#77.

b5bfdb1

jaraco closed this as completed in 972d1b3 Jul 6, 2023

jaraco mentioned this issue Nov 5, 2023

Update best practices pypa/distutils#217

Merged

jaraco mentioned this issue Dec 15, 2024

Adopt project skeleton coherent-oss/pytest-black#1

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs should link back to PyPI or Github project #77

Docs should link back to PyPI or Github project #77

jaraco commented Apr 10, 2023

jaraco commented Jul 5, 2023

jaraco commented Jul 5, 2023

jaraco commented Jul 6, 2023

Docs should link back to PyPI or Github project #77

Docs should link back to PyPI or Github project #77

Comments

jaraco commented Apr 10, 2023

jaraco commented Jul 5, 2023

jaraco commented Jul 5, 2023

jaraco commented Jul 6, 2023