{"id":19931068,"url":"https://github.com/sphinx-contrib/sphinxcontrib-towncrier","last_synced_at":"2025-04-06T07:11:01.088Z","repository":{"id":45216334,"uuid":"284275487","full_name":"sphinx-contrib/sphinxcontrib-towncrier","owner":"sphinx-contrib","description":"An RST directive for injecting a Towncrier-generated changelog draft containing fragments for the unreleased (next) project version. Demo: https://ansible-pylibssh.rtfd.io/changelog. Docs: https://sphinxcontrib-towncrier.rtfd.io","archived":false,"fork":false,"pushed_at":"2025-03-23T22:04:19.000Z","size":794,"stargazers_count":18,"open_issues_count":9,"forks_count":18,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-30T06:05:11.437Z","etag":null,"topics":["hacktoberfest","sphinx","sphinx-doc","sphinx-extension"],"latest_commit_sha":null,"homepage":"https://pypi.org/p/sphinxcontrib-towncrier","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sphinx-contrib.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.rst","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"custom":["https://www.comebackalive.in.ua/donate","https://github.com/vshymanskyy/StandWithUkraine#for-maintainers-and-authors","https://www.paypal.me/webknjazCZ","https://webknjaz.me"],"github":["slsh1o","webknjaz"],"ko_fi":"webknjaz","liberapay":"webknjaz","open_collective":"webknjaz","thanks_dev":"u/gh/webknjaz"}},"created_at":"2020-08-01T14:27:02.000Z","updated_at":"2025-03-23T22:04:21.000Z","dependencies_parsed_at":"2023-02-08T14:16:35.437Z","dependency_job_id":"da182614-54b2-4d42-ae61-2401c8fd25f1","html_url":"https://github.com/sphinx-contrib/sphinxcontrib-towncrier","commit_stats":{"total_commits":256,"total_committers":13,"mean_commits":"19.692307692307693","dds":0.2421875,"last_synced_commit":"b1572a32a6e17352c013ac5c49615f3525d8e904"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fsphinxcontrib-towncrier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fsphinxcontrib-towncrier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fsphinxcontrib-towncrier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fsphinxcontrib-towncrier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sphinx-contrib","download_url":"https://codeload.github.com/sphinx-contrib/sphinxcontrib-towncrier/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247445669,"owners_count":20939958,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","sphinx","sphinx-doc","sphinx-extension"],"created_at":"2024-11-12T23:06:00.942Z","updated_at":"2025-04-06T07:11:01.061Z","avatar_url":"https://github.com/sphinx-contrib.png","language":"Python","funding_links":["https://www.comebackalive.in.ua/donate","https://github.com/vshymanskyy/StandWithUkraine#for-maintainers-and-authors","https://www.paypal.me/webknjazCZ","https://webknjaz.me","https://github.com/sponsors/slsh1o","https://github.com/sponsors/webknjaz","https://ko-fi.com/webknjaz","https://liberapay.com/webknjaz","https://opencollective.com/webknjaz","https://thanks.dev/u/gh/webknjaz"],"categories":[],"sub_categories":[],"readme":".. image:: https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direct-team.svg\n   :target: https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md\n   :alt: SWUbanner\n\n.. image:: https://img.shields.io/pypi/v/sphinxcontrib-towncrier.svg?logo=Python\u0026logoColor=white\n   :target: https://pypi.org/project/sphinxcontrib-towncrier\n   :alt: sphinxcontrib-towncrier @ PyPI\n\n.. image:: https://github.com/sphinx-contrib/sphinxcontrib-towncrier/actions/workflows/ci-cd.yml/badge.svg?event=push\n   :target: https://github.com/sphinx-contrib/sphinxcontrib-towncrier/actions/workflows/ci-cd.yml\n   :alt: GitHub Actions CI/CD build status — Python package\n\n.. image:: https://codecov.io/gh/sphinx-contrib/sphinxcontrib-towncrier/branch/master/graph/badge.svg\n   :target: https://codecov.io/gh/sphinx-contrib/sphinxcontrib-towncrier\n   :alt: sphinxcontrib-towncrier coverage charts @ Covecov.io\n\n.. DO-NOT-REMOVE-docs-badges-END\n\n.. image:: https://img.shields.io/readthedocs/sphinxcontrib-towncrier/latest.svg?logo=Read%20The%20Docs\u0026logoColor=white\n   :target: https://sphinxcontrib-towncrier.rtfd.io/en/latest/?badge=latest\n   :alt: Documentation Status @ RTD\n\nsphinxcontrib-towncrier\n=======================\n\n.. DO-NOT-REMOVE-docs-intro-START\n\nAn RST directive for injecting a Towncrier-generated changelog draft\ncontaining fragments for the unreleased (next) project version.\n\n\nHow to use this?\n----------------\n\n.. code-block:: shell-session\n\n    $ pip install sphinxcontrib-towncrier\n\n.. code-block:: python\n\n    extensions = ['sphinxcontrib.towncrier.ext']\n\n    # Options: draft/sphinx-version/sphinx-release\n    towncrier_draft_autoversion_mode = 'draft'\n    towncrier_draft_include_empty = True\n    towncrier_draft_working_directory = PROJECT_ROOT_DIR\n    # Not yet supported:\n    # towncrier_draft_config_path = 'pyproject.toml'  # relative to cwd\n\nMake sure to point to the dir with ``pyproject.toml`` and pre-configure\ntowncrier itself in the config.\n\nIf everything above is  set up correctly, you should be able to add\n\n.. code-block:: rst\n\n    .. towncrier-draft-entries::\n\nto your documents, like ``changelog.rst``. With no argument, the version\ntitle will be generated using the strategy set up in the\n``towncrier_draft_autoversion_mode`` setting.\n\nIf you want to be in control, override it with an argument you like:\n\n.. code-block:: rst\n\n    .. towncrier-draft-entries:: |release| [UNRELEASED DRAFT]\n\nNative RST substitutions in the argument work, just make sure to declare\nany non-default ones via ``rst_epilog`` or at the end of the document\nwhere the ``towncrier-draft-entries`` directive is being used.\n\n\nDoes anybody actually use this?\n-------------------------------\n\nSo far we know about two projects using ``sphinxcontrib-towncrier`` —\nansible/pylibssh and pypa/pip. Also, this Sphinx extension is inspired\nby and somewhat based on the ideas used in pytest-dev/pytest and\ntox-dev/tox. We believe that these projects are full of wonderful tricks\nthat you may want to explore regardless of whether you'll use our\nproject.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-contrib%2Fsphinxcontrib-towncrier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsphinx-contrib%2Fsphinxcontrib-towncrier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-contrib%2Fsphinxcontrib-towncrier/lists"}