better-semantic-release 1.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- better_semantic_release-1.0.0/LICENSE +23 -0
- better_semantic_release-1.0.0/MANIFEST.in +12 -0
- better_semantic_release-1.0.0/PKG-INFO +145 -0
- better_semantic_release-1.0.0/README.rst +66 -0
- better_semantic_release-1.0.0/docs/Makefile +183 -0
- better_semantic_release-1.0.0/docs/api/commands.rst +580 -0
- better_semantic_release-1.0.0/docs/concepts/changelog_templates.rst +1246 -0
- better_semantic_release-1.0.0/docs/concepts/commit_parsing.rst +785 -0
- better_semantic_release-1.0.0/docs/concepts/getting_started.rst +384 -0
- better_semantic_release-1.0.0/docs/concepts/index.rst +17 -0
- better_semantic_release-1.0.0/docs/concepts/installation.rst +14 -0
- better_semantic_release-1.0.0/docs/concepts/multibranch_releases.rst +167 -0
- better_semantic_release-1.0.0/docs/concepts/strict_mode.rst +72 -0
- better_semantic_release-1.0.0/docs/conf.py +100 -0
- better_semantic_release-1.0.0/docs/configuration/automatic-releases/cronjobs.rst +41 -0
- better_semantic_release-1.0.0/docs/configuration/automatic-releases/github-actions.rst +1119 -0
- better_semantic_release-1.0.0/docs/configuration/automatic-releases/index.rst +20 -0
- better_semantic_release-1.0.0/docs/configuration/automatic-releases/travis.rst +55 -0
- better_semantic_release-1.0.0/docs/configuration/configuration-guides/index.rst +15 -0
- better_semantic_release-1.0.0/docs/configuration/configuration-guides/monorepos-ex-easy-before-release.png +0 -0
- better_semantic_release-1.0.0/docs/configuration/configuration-guides/monorepos-ex-easy-post-release.png +0 -0
- better_semantic_release-1.0.0/docs/configuration/configuration-guides/monorepos.rst +358 -0
- better_semantic_release-1.0.0/docs/configuration/configuration-guides/uv_integration.rst +329 -0
- better_semantic_release-1.0.0/docs/configuration/configuration.rst +1545 -0
- better_semantic_release-1.0.0/docs/configuration/index.rst +24 -0
- better_semantic_release-1.0.0/docs/contributing/contributing_guide.rst +1 -0
- better_semantic_release-1.0.0/docs/contributing/index.rst +35 -0
- better_semantic_release-1.0.0/docs/index.rst +76 -0
- better_semantic_release-1.0.0/docs/make.bat +242 -0
- better_semantic_release-1.0.0/docs/misc/psr_changelog.rst +1 -0
- better_semantic_release-1.0.0/docs/misc/troubleshooting.rst +38 -0
- better_semantic_release-1.0.0/docs/upgrading/08-upgrade.rst +628 -0
- better_semantic_release-1.0.0/docs/upgrading/09-upgrade.rst +11 -0
- better_semantic_release-1.0.0/docs/upgrading/10-upgrade.rst +222 -0
- better_semantic_release-1.0.0/docs/upgrading/index.rst +27 -0
- better_semantic_release-1.0.0/pyproject.toml +479 -0
- better_semantic_release-1.0.0/setup.cfg +4 -0
- better_semantic_release-1.0.0/src/better_semantic_release.egg-info/SOURCES.txt +247 -0
- better_semantic_release-1.0.0/src/semantic_release/__init__.py +61 -0
- better_semantic_release-1.0.0/src/semantic_release/__main__.py +54 -0
- better_semantic_release-1.0.0/src/semantic_release/bsr/__init__.py +6 -0
- better_semantic_release-1.0.0/src/semantic_release/bsr/config.py +41 -0
- better_semantic_release-1.0.0/src/semantic_release/bsr/errors.py +38 -0
- better_semantic_release-1.0.0/src/semantic_release/bsr/guards.py +110 -0
- better_semantic_release-1.0.0/src/semantic_release/bsr/registry.py +63 -0
- better_semantic_release-1.0.0/src/semantic_release/changelog/__init__.py +9 -0
- better_semantic_release-1.0.0/src/semantic_release/changelog/context.py +200 -0
- better_semantic_release-1.0.0/src/semantic_release/changelog/release_history.py +272 -0
- better_semantic_release-1.0.0/src/semantic_release/changelog/template.py +138 -0
- better_semantic_release-1.0.0/src/semantic_release/cli/__init__.py +0 -0
- better_semantic_release-1.0.0/src/semantic_release/cli/changelog_writer.py +284 -0
- better_semantic_release-1.0.0/src/semantic_release/cli/cli_context.py +124 -0
- better_semantic_release-1.0.0/src/semantic_release/cli/commands/__init__.py +0 -0
- better_semantic_release-1.0.0/src/semantic_release/cli/commands/changelog.py +177 -0
- better_semantic_release-1.0.0/src/semantic_release/cli/commands/generate_config.py +74 -0
- better_semantic_release-1.0.0/src/semantic_release/cli/commands/main.py +144 -0
- better_semantic_release-1.0.0/src/semantic_release/cli/commands/publish.py +103 -0
- better_semantic_release-1.0.0/src/semantic_release/cli/commands/version.py +886 -0
- better_semantic_release-1.0.0/src/semantic_release/cli/config.py +932 -0
- better_semantic_release-1.0.0/src/semantic_release/cli/const.py +5 -0
- better_semantic_release-1.0.0/src/semantic_release/cli/github_actions_output.py +165 -0
- better_semantic_release-1.0.0/src/semantic_release/cli/masking_filter.py +78 -0
- better_semantic_release-1.0.0/src/semantic_release/cli/util.py +106 -0
- better_semantic_release-1.0.0/src/semantic_release/commit_parser/__init__.py +53 -0
- better_semantic_release-1.0.0/src/semantic_release/commit_parser/_base.py +84 -0
- better_semantic_release-1.0.0/src/semantic_release/commit_parser/angular.py +490 -0
- better_semantic_release-1.0.0/src/semantic_release/commit_parser/conventional/__init__.py +17 -0
- better_semantic_release-1.0.0/src/semantic_release/commit_parser/conventional/options.py +72 -0
- better_semantic_release-1.0.0/src/semantic_release/commit_parser/conventional/options_monorepo.py +99 -0
- better_semantic_release-1.0.0/src/semantic_release/commit_parser/conventional/parser.py +454 -0
- better_semantic_release-1.0.0/src/semantic_release/commit_parser/conventional/parser_monorepo.py +467 -0
- better_semantic_release-1.0.0/src/semantic_release/commit_parser/emoji.py +474 -0
- better_semantic_release-1.0.0/src/semantic_release/commit_parser/scipy.py +541 -0
- better_semantic_release-1.0.0/src/semantic_release/commit_parser/tag.py +107 -0
- better_semantic_release-1.0.0/src/semantic_release/commit_parser/token.py +215 -0
- better_semantic_release-1.0.0/src/semantic_release/commit_parser/util.py +129 -0
- better_semantic_release-1.0.0/src/semantic_release/const.py +30 -0
- better_semantic_release-1.0.0/src/semantic_release/data/templates/conventional/md/.components/changelog_header.md.j2 +9 -0
- better_semantic_release-1.0.0/src/semantic_release/data/templates/conventional/md/.components/changelog_init.md.j2 +29 -0
- better_semantic_release-1.0.0/src/semantic_release/data/templates/conventional/md/.components/changelog_update.md.j2 +71 -0
- better_semantic_release-1.0.0/src/semantic_release/data/templates/conventional/md/.components/changes.md.j2 +129 -0
- better_semantic_release-1.0.0/src/semantic_release/data/templates/conventional/md/.components/first_release.md.j2 +18 -0
- better_semantic_release-1.0.0/src/semantic_release/data/templates/conventional/md/.components/macros.md.j2 +199 -0
- better_semantic_release-1.0.0/src/semantic_release/data/templates/conventional/md/.components/unreleased_changes.md.j2 +7 -0
- better_semantic_release-1.0.0/src/semantic_release/data/templates/conventional/md/.components/versioned_changes.md.j2 +20 -0
- better_semantic_release-1.0.0/src/semantic_release/data/templates/conventional/md/.release_notes.md.j2 +62 -0
- better_semantic_release-1.0.0/src/semantic_release/data/templates/conventional/md/CHANGELOG.md.j2 +21 -0
- better_semantic_release-1.0.0/src/semantic_release/data/templates/conventional/rst/.components/changelog_header.rst.j2 +13 -0
- better_semantic_release-1.0.0/src/semantic_release/data/templates/conventional/rst/.components/changelog_init.rst.j2 +29 -0
- better_semantic_release-1.0.0/src/semantic_release/data/templates/conventional/rst/.components/changelog_update.rst.j2 +71 -0
- better_semantic_release-1.0.0/src/semantic_release/data/templates/conventional/rst/.components/changes.rst.j2 +166 -0
- better_semantic_release-1.0.0/src/semantic_release/data/templates/conventional/rst/.components/first_release.rst.j2 +22 -0
- better_semantic_release-1.0.0/src/semantic_release/data/templates/conventional/rst/.components/macros.rst.j2 +220 -0
- better_semantic_release-1.0.0/src/semantic_release/data/templates/conventional/rst/.components/unreleased_changes.rst.j2 +10 -0
- better_semantic_release-1.0.0/src/semantic_release/data/templates/conventional/rst/.components/versioned_changes.rst.j2 +25 -0
- better_semantic_release-1.0.0/src/semantic_release/data/templates/conventional/rst/CHANGELOG.rst.j2 +21 -0
- better_semantic_release-1.0.0/src/semantic_release/enums.py +69 -0
- better_semantic_release-1.0.0/src/semantic_release/errors.py +124 -0
- better_semantic_release-1.0.0/src/semantic_release/gitproject.py +495 -0
- better_semantic_release-1.0.0/src/semantic_release/globals.py +18 -0
- better_semantic_release-1.0.0/src/semantic_release/helpers.py +309 -0
- better_semantic_release-1.0.0/src/semantic_release/hvcs/__init__.py +17 -0
- better_semantic_release-1.0.0/src/semantic_release/hvcs/_base.py +78 -0
- better_semantic_release-1.0.0/src/semantic_release/hvcs/bitbucket.py +258 -0
- better_semantic_release-1.0.0/src/semantic_release/hvcs/gitea.py +410 -0
- better_semantic_release-1.0.0/src/semantic_release/hvcs/github.py +573 -0
- better_semantic_release-1.0.0/src/semantic_release/hvcs/gitlab.py +304 -0
- better_semantic_release-1.0.0/src/semantic_release/hvcs/remote_hvcs_base.py +199 -0
- better_semantic_release-1.0.0/src/semantic_release/hvcs/token_auth.py +23 -0
- better_semantic_release-1.0.0/src/semantic_release/hvcs/util.py +89 -0
- better_semantic_release-1.0.0/src/semantic_release/py.typed +0 -0
- better_semantic_release-1.0.0/src/semantic_release/version/__init__.py +7 -0
- better_semantic_release-1.0.0/src/semantic_release/version/algorithm.py +403 -0
- better_semantic_release-1.0.0/src/semantic_release/version/declaration.py +108 -0
- better_semantic_release-1.0.0/src/semantic_release/version/declarations/__init__.py +0 -0
- better_semantic_release-1.0.0/src/semantic_release/version/declarations/enum.py +12 -0
- better_semantic_release-1.0.0/src/semantic_release/version/declarations/file.py +145 -0
- better_semantic_release-1.0.0/src/semantic_release/version/declarations/i_version_replacer.py +73 -0
- better_semantic_release-1.0.0/src/semantic_release/version/declarations/pattern.py +238 -0
- better_semantic_release-1.0.0/src/semantic_release/version/declarations/toml.py +159 -0
- better_semantic_release-1.0.0/src/semantic_release/version/translator.py +101 -0
- better_semantic_release-1.0.0/src/semantic_release/version/version.py +399 -0
- better_semantic_release-1.0.0/tests/__init__.py +0 -0
- better_semantic_release-1.0.0/tests/conftest.py +587 -0
- better_semantic_release-1.0.0/tests/const.py +334 -0
- better_semantic_release-1.0.0/tests/e2e/__init__.py +0 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_changelog/__init__.py +0 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_changelog/test_changelog.py +1256 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_changelog/test_changelog_custom_parser.py +89 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_changelog/test_changelog_parsing.py +136 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_changelog/test_changelog_release_notes.py +319 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_config/__init__.py +0 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_config/test_generate_config.py +237 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_publish/__init__.py +0 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_publish/test_publish.py +170 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/__init__.py +0 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/bump_version/__init__.py +0 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/bump_version/conftest.py +158 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/bump_version/git_flow/__init__.py +0 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/bump_version/git_flow/test_repo_1_channel.py +172 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/bump_version/git_flow/test_repo_2_channels.py +172 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/bump_version/git_flow/test_repo_3_channels.py +173 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/bump_version/git_flow/test_repo_4_channels.py +172 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/bump_version/github_flow/__init__.py +0 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/bump_version/github_flow/test_repo_1_channel.py +172 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/bump_version/github_flow/test_repo_1_channel_branch_update_merge.py +185 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/bump_version/github_flow/test_repo_2_channels.py +172 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/bump_version/github_flow_monorepo/__init__.py +0 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/bump_version/github_flow_monorepo/test_monorepo_1_channel.py +260 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/bump_version/github_flow_monorepo/test_monorepo_2_channels.py +259 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/bump_version/trunk_based_dev/__init__.py +0 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/bump_version/trunk_based_dev/test_repo_trunk.py +174 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/bump_version/trunk_based_dev/test_repo_trunk_dual_version_support.py +180 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/bump_version/trunk_based_dev/test_repo_trunk_dual_version_support_w_prereleases.py +181 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/bump_version/trunk_based_dev/test_repo_trunk_w_prereleases.py +172 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/bump_version/trunk_based_dev_monorepo/__init__.py +0 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/bump_version/trunk_based_dev_monorepo/test_monorepo_trunk.py +260 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/test_version.py +333 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/test_version_build.py +368 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/test_version_bump.py +3272 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/test_version_changelog.py +901 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/test_version_changelog_custom_commit_msg.py +211 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/test_version_github_actions.py +116 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/test_version_partial_tag.py +346 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/test_version_print.py +1076 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/test_version_release_notes.py +190 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/test_version_shallow.py +306 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/test_version_stamp.py +630 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/test_version_strict.py +121 -0
- better_semantic_release-1.0.0/tests/e2e/cmd_version/test_version_upstream_check.py +574 -0
- better_semantic_release-1.0.0/tests/e2e/conftest.py +238 -0
- better_semantic_release-1.0.0/tests/e2e/test_help.py +232 -0
- better_semantic_release-1.0.0/tests/e2e/test_main.py +273 -0
- better_semantic_release-1.0.0/tests/fixtures/__init__.py +6 -0
- better_semantic_release-1.0.0/tests/fixtures/commit_parsers.py +85 -0
- better_semantic_release-1.0.0/tests/fixtures/example_project.py +840 -0
- better_semantic_release-1.0.0/tests/fixtures/git_repo.py +2581 -0
- better_semantic_release-1.0.0/tests/fixtures/monorepos/__init__.py +4 -0
- better_semantic_release-1.0.0/tests/fixtures/monorepos/example_monorepo.py +591 -0
- better_semantic_release-1.0.0/tests/fixtures/monorepos/git_monorepo.py +219 -0
- better_semantic_release-1.0.0/tests/fixtures/monorepos/github_flow/__init__.py +2 -0
- better_semantic_release-1.0.0/tests/fixtures/monorepos/github_flow/monorepo_w_default_release.py +967 -0
- better_semantic_release-1.0.0/tests/fixtures/monorepos/github_flow/monorepo_w_release_channels.py +893 -0
- better_semantic_release-1.0.0/tests/fixtures/monorepos/trunk_based_dev/__init__.py +1 -0
- better_semantic_release-1.0.0/tests/fixtures/monorepos/trunk_based_dev/monorepo_w_tags.py +639 -0
- better_semantic_release-1.0.0/tests/fixtures/repos/__init__.py +4 -0
- better_semantic_release-1.0.0/tests/fixtures/repos/git_flow/__init__.py +4 -0
- better_semantic_release-1.0.0/tests/fixtures/repos/git_flow/repo_w_1_release_channel.py +966 -0
- better_semantic_release-1.0.0/tests/fixtures/repos/git_flow/repo_w_2_release_channels.py +1016 -0
- better_semantic_release-1.0.0/tests/fixtures/repos/git_flow/repo_w_3_release_channels.py +1098 -0
- better_semantic_release-1.0.0/tests/fixtures/repos/git_flow/repo_w_4_release_channels.py +1013 -0
- better_semantic_release-1.0.0/tests/fixtures/repos/github_flow/__init__.py +3 -0
- better_semantic_release-1.0.0/tests/fixtures/repos/github_flow/repo_w_default_release.py +557 -0
- better_semantic_release-1.0.0/tests/fixtures/repos/github_flow/repo_w_default_release_w_branch_update_merge.py +562 -0
- better_semantic_release-1.0.0/tests/fixtures/repos/github_flow/repo_w_release_channels.py +603 -0
- better_semantic_release-1.0.0/tests/fixtures/repos/repo_initial_commit.py +230 -0
- better_semantic_release-1.0.0/tests/fixtures/repos/trunk_based_dev/__init__.py +5 -0
- better_semantic_release-1.0.0/tests/fixtures/repos/trunk_based_dev/repo_w_dual_version_support.py +505 -0
- better_semantic_release-1.0.0/tests/fixtures/repos/trunk_based_dev/repo_w_dual_version_support_w_prereleases.py +602 -0
- better_semantic_release-1.0.0/tests/fixtures/repos/trunk_based_dev/repo_w_no_tags.py +436 -0
- better_semantic_release-1.0.0/tests/fixtures/repos/trunk_based_dev/repo_w_prereleases.py +447 -0
- better_semantic_release-1.0.0/tests/fixtures/repos/trunk_based_dev/repo_w_tags.py +401 -0
- better_semantic_release-1.0.0/tests/fixtures/scipy.py +396 -0
- better_semantic_release-1.0.0/tests/unit/__init__.py +0 -0
- better_semantic_release-1.0.0/tests/unit/conftest.py +16 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/__init__.py +0 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/bsr/__init__.py +0 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/bsr/test_config.py +46 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/bsr/test_guards.py +150 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/bsr/test_registry.py +33 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/bsr/test_version_hook.py +195 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/changelog/__init__.py +0 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/changelog/conftest.py +426 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/changelog/test_changelog_context.py +752 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/changelog/test_default_changelog.py +1028 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/changelog/test_release_history.py +304 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/changelog/test_release_notes.py +1051 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/changelog/test_template.py +67 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/changelog/test_template_render.py +177 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/cli/__init__.py +0 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/cli/test_config.py +465 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/cli/test_github_actions_output.py +161 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/cli/test_masking_filter.py +233 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/cli/test_util.py +214 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/cli/test_version.py +23 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/commit_parser/__init__.py +0 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/commit_parser/test_conventional.py +1232 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/commit_parser/test_emoji.py +1083 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/commit_parser/test_parsed_commit.py +27 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/commit_parser/test_scipy.py +1363 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/commit_parser/test_util.py +26 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/hvcs/__init__.py +0 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/hvcs/test__base.py +62 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/hvcs/test_bitbucket.py +336 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/hvcs/test_gitea.py +848 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/hvcs/test_github.py +1316 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/hvcs/test_gitlab.py +529 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/hvcs/test_token_auth.py +43 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/hvcs/test_util.py +0 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/test_gitproject.py +332 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/test_helpers.py +322 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/version/__init__.py +0 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/version/declarations/__init__.py +0 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/version/declarations/test_file_declaration.py +279 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/version/declarations/test_pattern_declaration.py +534 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/version/declarations/test_toml_declaration.py +348 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/version/test_algorithm.py +371 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/version/test_translator.py +94 -0
- better_semantic_release-1.0.0/tests/unit/semantic_release/version/test_version.py +331 -0
- better_semantic_release-1.0.0/tests/util.py +364 -0
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
The MIT License (MIT)
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2015 Rolf Erik Lekang
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
22
|
+
|
|
23
|
+
Copyright (c) 2026 n24q02m (better-semantic-release fork)
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Make sure non-python files are included
|
|
2
|
+
graft src/**/data/
|
|
3
|
+
|
|
4
|
+
# include docs & testing into sdist, ignored for wheel build
|
|
5
|
+
graft docs/
|
|
6
|
+
prune docs/_build/
|
|
7
|
+
graft tests/
|
|
8
|
+
prune tests/gh_action/
|
|
9
|
+
|
|
10
|
+
# Remove any generated files
|
|
11
|
+
prune **/__pycache__/
|
|
12
|
+
prune src/*.egg-info
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: better-semantic-release
|
|
3
|
+
Version: 1.0.0
|
|
4
|
+
Summary: Drop-in python-semantic-release fork with built-in release-safety guards (orphan-tag + registry-collision).
|
|
5
|
+
Author-email: Rolf Erik Lekang <me@rolflekang.com>, codejedi365 <codejedi365@gmail.com>
|
|
6
|
+
License: MIT
|
|
7
|
+
Project-URL: changelog, https://github.com/n24q02m/better-semantic-release/blob/main/CHANGELOG.rst
|
|
8
|
+
Project-URL: documentation, https://github.com/n24q02m/better-semantic-release#readme
|
|
9
|
+
Project-URL: homepage, https://github.com/n24q02m/better-semantic-release
|
|
10
|
+
Project-URL: issues, https://github.com/n24q02m/better-semantic-release/issues
|
|
11
|
+
Project-URL: repository, https://github.com/n24q02m/better-semantic-release.git
|
|
12
|
+
Classifier: Programming Language :: Python
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
21
|
+
Requires-Python: ~=3.8
|
|
22
|
+
Description-Content-Type: text/x-rst
|
|
23
|
+
License-File: LICENSE
|
|
24
|
+
Requires-Dist: click~=8.1.0; python_version == "3.8"
|
|
25
|
+
Requires-Dist: click~=8.1.0; python_version == "3.9"
|
|
26
|
+
Requires-Dist: click<8.5.0,~=8.1.0; python_version >= "3.10"
|
|
27
|
+
Requires-Dist: click-option-group~=0.5.0
|
|
28
|
+
Requires-Dist: gitpython~=3.0
|
|
29
|
+
Requires-Dist: requests~=2.25
|
|
30
|
+
Requires-Dist: jinja2~=3.1
|
|
31
|
+
Requires-Dist: python-gitlab~=4.0; python_version == "3.8"
|
|
32
|
+
Requires-Dist: python-gitlab<7.0.0,>=4.0.0; python_version == "3.9"
|
|
33
|
+
Requires-Dist: python-gitlab<9.0.0,>=4.0.0; python_version >= "3.10"
|
|
34
|
+
Requires-Dist: tomlkit~=0.13.0; python_version == "3.8"
|
|
35
|
+
Requires-Dist: tomlkit~=0.15.0; python_version >= "3.9"
|
|
36
|
+
Requires-Dist: dotty-dict~=1.3
|
|
37
|
+
Requires-Dist: importlib-resources~=6.0; python_version == "3.8"
|
|
38
|
+
Requires-Dist: pydantic~=2.0
|
|
39
|
+
Requires-Dist: rich~=14.0; python_version == "3.8"
|
|
40
|
+
Requires-Dist: rich~=15.0; python_version >= "3.9"
|
|
41
|
+
Requires-Dist: shellingham~=1.5
|
|
42
|
+
Requires-Dist: Deprecated~=1.2
|
|
43
|
+
Provides-Extra: build
|
|
44
|
+
Requires-Dist: build~=1.2; extra == "build"
|
|
45
|
+
Requires-Dist: tomlkit~=0.13.0; python_version == "3.8" and extra == "build"
|
|
46
|
+
Requires-Dist: tomlkit~=0.15.0; python_version >= "3.9" and extra == "build"
|
|
47
|
+
Provides-Extra: docs
|
|
48
|
+
Requires-Dist: Sphinx~=7.4; extra == "docs"
|
|
49
|
+
Requires-Dist: sphinxcontrib-apidoc==0.6.0; extra == "docs"
|
|
50
|
+
Requires-Dist: sphinx-autobuild==2024.2.4; extra == "docs"
|
|
51
|
+
Requires-Dist: furo~=2025.9; extra == "docs"
|
|
52
|
+
Provides-Extra: test
|
|
53
|
+
Requires-Dist: coverage[toml]~=7.0; extra == "test"
|
|
54
|
+
Requires-Dist: filelock~=3.15; extra == "test"
|
|
55
|
+
Requires-Dist: flatdict~=4.0; extra == "test"
|
|
56
|
+
Requires-Dist: freezegun~=1.5; extra == "test"
|
|
57
|
+
Requires-Dist: pyyaml~=6.0; extra == "test"
|
|
58
|
+
Requires-Dist: pytest<10.0,>=8.3; extra == "test"
|
|
59
|
+
Requires-Dist: pytest-clarity~=1.0; extra == "test"
|
|
60
|
+
Requires-Dist: pytest-cov<8.0.0,>=5.0.0; extra == "test"
|
|
61
|
+
Requires-Dist: pytest-env~=1.0; extra == "test"
|
|
62
|
+
Requires-Dist: pytest-lazy-fixtures~=1.4; extra == "test"
|
|
63
|
+
Requires-Dist: pytest-mock~=3.0; extra == "test"
|
|
64
|
+
Requires-Dist: pytest-order~=1.3; extra == "test"
|
|
65
|
+
Requires-Dist: pytest-pretty~=1.2; extra == "test"
|
|
66
|
+
Requires-Dist: pytest-xdist~=3.0; extra == "test"
|
|
67
|
+
Requires-Dist: responses~=0.26.2; extra == "test"
|
|
68
|
+
Requires-Dist: requests-mock~=1.10; extra == "test"
|
|
69
|
+
Provides-Extra: dev
|
|
70
|
+
Requires-Dist: pre-commit<5.0.0,>=3.5.0; extra == "dev"
|
|
71
|
+
Requires-Dist: tox~=4.11; extra == "dev"
|
|
72
|
+
Requires-Dist: ruff==0.6.1; extra == "dev"
|
|
73
|
+
Provides-Extra: mypy
|
|
74
|
+
Requires-Dist: mypy<2.0.0,>=1.14.1; extra == "mypy"
|
|
75
|
+
Requires-Dist: types-Deprecated~=1.2; extra == "mypy"
|
|
76
|
+
Requires-Dist: types-requests<3.0.0,>=2.32.0; extra == "mypy"
|
|
77
|
+
Requires-Dist: types-pyyaml~=6.0; extra == "mypy"
|
|
78
|
+
Dynamic: license-file
|
|
79
|
+
|
|
80
|
+
better-semantic-release
|
|
81
|
+
***********************
|
|
82
|
+
|
|
83
|
+
*A drop-in fork of python-semantic-release with built-in release-safety guards.*
|
|
84
|
+
|
|
85
|
+
----
|
|
86
|
+
|
|
87
|
+
``better-semantic-release`` is a drop-in fork of `python-semantic-release`_ (MIT licensed).
|
|
88
|
+
It keeps the same ``[tool.semantic_release]`` configuration schema, the same
|
|
89
|
+
``semantic-release`` CLI, and the same GitHub Action interface -- switching over only
|
|
90
|
+
requires pointing the ``uses:`` line at the fork:
|
|
91
|
+
|
|
92
|
+
.. code-block:: yaml
|
|
93
|
+
|
|
94
|
+
uses: n24q02m/better-semantic-release@v<major>
|
|
95
|
+
|
|
96
|
+
On top of that, the fork adds release-safety guards that run automatically before any
|
|
97
|
+
commit, tag, or push is made. Guards can be opted out of per-repository under the
|
|
98
|
+
``[tool.semantic_release.bsr]`` table in ``pyproject.toml``.
|
|
99
|
+
|
|
100
|
+
How it differs from upstream
|
|
101
|
+
=============================
|
|
102
|
+
|
|
103
|
+
.. list-table::
|
|
104
|
+
:header-rows: 1
|
|
105
|
+
:widths: 40 25 35
|
|
106
|
+
|
|
107
|
+
* - Behavior
|
|
108
|
+
- Upstream (python-semantic-release)
|
|
109
|
+
- better-semantic-release
|
|
110
|
+
* - Orphaned release-tag detection (a rebase or force-push silently
|
|
111
|
+
freezes releases on a tag nobody notices)
|
|
112
|
+
- None
|
|
113
|
+
- Built-in, fails loud
|
|
114
|
+
* - Registry-collision detection (re-publishing a version that already
|
|
115
|
+
exists on the target registry)
|
|
116
|
+
- None
|
|
117
|
+
- Built-in, fails closed
|
|
118
|
+
* - Config / CLI / GitHub Action interface
|
|
119
|
+
- --
|
|
120
|
+
- Identical (drop-in)
|
|
121
|
+
|
|
122
|
+
----
|
|
123
|
+
|
|
124
|
+
Python Semantic Release
|
|
125
|
+
***********************
|
|
126
|
+
|
|
127
|
+
*Automating Releases via SemVer and Commit Message Conventions*
|
|
128
|
+
|
|
129
|
+
----
|
|
130
|
+
|
|
131
|
+
The official documentation for Python Semantic Release can be found at
|
|
132
|
+
`python-semantic-release.readthedocs.io`_.
|
|
133
|
+
|
|
134
|
+
GitHub Action
|
|
135
|
+
=============
|
|
136
|
+
|
|
137
|
+
When using the Python Semantic Release GitHub Action, it executes the command
|
|
138
|
+
``semantic-release version`` using `python-semantic-release`_.
|
|
139
|
+
|
|
140
|
+
The usage information and examples for this GitHub Action is available under
|
|
141
|
+
the `GitHub Actions section`_ of `python-semantic-release.readthedocs.io`_.
|
|
142
|
+
|
|
143
|
+
.. _python-semantic-release: https://pypi.org/project/python-semantic-release/
|
|
144
|
+
.. _python-semantic-release.readthedocs.io: https://python-semantic-release.readthedocs.io/en/stable/
|
|
145
|
+
.. _GitHub Actions section: https://python-semantic-release.readthedocs.io/en/stable/configuration/automatic-releases/github-actions.html
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
better-semantic-release
|
|
2
|
+
***********************
|
|
3
|
+
|
|
4
|
+
*A drop-in fork of python-semantic-release with built-in release-safety guards.*
|
|
5
|
+
|
|
6
|
+
----
|
|
7
|
+
|
|
8
|
+
``better-semantic-release`` is a drop-in fork of `python-semantic-release`_ (MIT licensed).
|
|
9
|
+
It keeps the same ``[tool.semantic_release]`` configuration schema, the same
|
|
10
|
+
``semantic-release`` CLI, and the same GitHub Action interface -- switching over only
|
|
11
|
+
requires pointing the ``uses:`` line at the fork:
|
|
12
|
+
|
|
13
|
+
.. code-block:: yaml
|
|
14
|
+
|
|
15
|
+
uses: n24q02m/better-semantic-release@v<major>
|
|
16
|
+
|
|
17
|
+
On top of that, the fork adds release-safety guards that run automatically before any
|
|
18
|
+
commit, tag, or push is made. Guards can be opted out of per-repository under the
|
|
19
|
+
``[tool.semantic_release.bsr]`` table in ``pyproject.toml``.
|
|
20
|
+
|
|
21
|
+
How it differs from upstream
|
|
22
|
+
=============================
|
|
23
|
+
|
|
24
|
+
.. list-table::
|
|
25
|
+
:header-rows: 1
|
|
26
|
+
:widths: 40 25 35
|
|
27
|
+
|
|
28
|
+
* - Behavior
|
|
29
|
+
- Upstream (python-semantic-release)
|
|
30
|
+
- better-semantic-release
|
|
31
|
+
* - Orphaned release-tag detection (a rebase or force-push silently
|
|
32
|
+
freezes releases on a tag nobody notices)
|
|
33
|
+
- None
|
|
34
|
+
- Built-in, fails loud
|
|
35
|
+
* - Registry-collision detection (re-publishing a version that already
|
|
36
|
+
exists on the target registry)
|
|
37
|
+
- None
|
|
38
|
+
- Built-in, fails closed
|
|
39
|
+
* - Config / CLI / GitHub Action interface
|
|
40
|
+
- --
|
|
41
|
+
- Identical (drop-in)
|
|
42
|
+
|
|
43
|
+
----
|
|
44
|
+
|
|
45
|
+
Python Semantic Release
|
|
46
|
+
***********************
|
|
47
|
+
|
|
48
|
+
*Automating Releases via SemVer and Commit Message Conventions*
|
|
49
|
+
|
|
50
|
+
----
|
|
51
|
+
|
|
52
|
+
The official documentation for Python Semantic Release can be found at
|
|
53
|
+
`python-semantic-release.readthedocs.io`_.
|
|
54
|
+
|
|
55
|
+
GitHub Action
|
|
56
|
+
=============
|
|
57
|
+
|
|
58
|
+
When using the Python Semantic Release GitHub Action, it executes the command
|
|
59
|
+
``semantic-release version`` using `python-semantic-release`_.
|
|
60
|
+
|
|
61
|
+
The usage information and examples for this GitHub Action is available under
|
|
62
|
+
the `GitHub Actions section`_ of `python-semantic-release.readthedocs.io`_.
|
|
63
|
+
|
|
64
|
+
.. _python-semantic-release: https://pypi.org/project/python-semantic-release/
|
|
65
|
+
.. _python-semantic-release.readthedocs.io: https://python-semantic-release.readthedocs.io/en/stable/
|
|
66
|
+
.. _GitHub Actions section: https://python-semantic-release.readthedocs.io/en/stable/configuration/automatic-releases/github-actions.html
|
|
@@ -0,0 +1,183 @@
|
|
|
1
|
+
# Makefile for Sphinx documentation
|
|
2
|
+
#
|
|
3
|
+
|
|
4
|
+
# You can set these variables from the command line.
|
|
5
|
+
SPHINXOPTS =
|
|
6
|
+
SPHINXBUILD = sphinx-build
|
|
7
|
+
PAPER =
|
|
8
|
+
BUILDDIR = _build
|
|
9
|
+
|
|
10
|
+
# User-friendly check for sphinx-build
|
|
11
|
+
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
|
|
12
|
+
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
|
|
13
|
+
endif
|
|
14
|
+
|
|
15
|
+
# Internal variables.
|
|
16
|
+
PAPEROPT_a4 = -D latex_paper_size=a4
|
|
17
|
+
PAPEROPT_letter = -D latex_paper_size=letter
|
|
18
|
+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
|
19
|
+
# the i18n builder cannot share the environment and doctrees with the others
|
|
20
|
+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
|
21
|
+
|
|
22
|
+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
|
|
23
|
+
|
|
24
|
+
help:
|
|
25
|
+
@echo "Please use \`make <target>' where <target> is one of"
|
|
26
|
+
@echo " html to make standalone HTML files"
|
|
27
|
+
@echo " dirhtml to make HTML files named index.html in directories"
|
|
28
|
+
@echo " singlehtml to make a single large HTML file"
|
|
29
|
+
@echo " pickle to make pickle files"
|
|
30
|
+
@echo " json to make JSON files"
|
|
31
|
+
@echo " htmlhelp to make HTML files and a HTML help project"
|
|
32
|
+
@echo " qthelp to make HTML files and a qthelp project"
|
|
33
|
+
@echo " devhelp to make HTML files and a Devhelp project"
|
|
34
|
+
@echo " epub to make an epub"
|
|
35
|
+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
|
36
|
+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
|
37
|
+
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
|
38
|
+
@echo " text to make text files"
|
|
39
|
+
@echo " man to make manual pages"
|
|
40
|
+
@echo " texinfo to make Texinfo files"
|
|
41
|
+
@echo " info to make Texinfo files and run them through makeinfo"
|
|
42
|
+
@echo " gettext to make PO message catalogs"
|
|
43
|
+
@echo " changes to make an overview of all changed/added/deprecated items"
|
|
44
|
+
@echo " xml to make Docutils-native XML files"
|
|
45
|
+
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
|
46
|
+
@echo " linkcheck to check all external links for integrity"
|
|
47
|
+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
|
48
|
+
|
|
49
|
+
clean:
|
|
50
|
+
rm -rf $(BUILDDIR)/*
|
|
51
|
+
|
|
52
|
+
html:
|
|
53
|
+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
|
54
|
+
@echo
|
|
55
|
+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
|
56
|
+
|
|
57
|
+
dirhtml:
|
|
58
|
+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
|
59
|
+
@echo
|
|
60
|
+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
|
61
|
+
|
|
62
|
+
singlehtml:
|
|
63
|
+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
|
64
|
+
@echo
|
|
65
|
+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
|
66
|
+
|
|
67
|
+
pickle:
|
|
68
|
+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
|
69
|
+
@echo
|
|
70
|
+
@echo "Build finished; now you can process the pickle files."
|
|
71
|
+
|
|
72
|
+
json:
|
|
73
|
+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
|
74
|
+
@echo
|
|
75
|
+
@echo "Build finished; now you can process the JSON files."
|
|
76
|
+
|
|
77
|
+
htmlhelp:
|
|
78
|
+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
|
79
|
+
@echo
|
|
80
|
+
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
|
81
|
+
".hhp project file in $(BUILDDIR)/htmlhelp."
|
|
82
|
+
|
|
83
|
+
qthelp:
|
|
84
|
+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
|
85
|
+
@echo
|
|
86
|
+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
|
87
|
+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
|
88
|
+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/python-semantic-release.qhcp"
|
|
89
|
+
@echo "To view the help file:"
|
|
90
|
+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/python-semantic-release.qhc"
|
|
91
|
+
|
|
92
|
+
devhelp:
|
|
93
|
+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
|
94
|
+
@echo
|
|
95
|
+
@echo "Build finished."
|
|
96
|
+
@echo "To view the help file:"
|
|
97
|
+
@echo "# mkdir -p $$HOME/.local/share/devhelp/python-semantic-release"
|
|
98
|
+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/python-semantic-release"
|
|
99
|
+
@echo "# devhelp"
|
|
100
|
+
|
|
101
|
+
epub:
|
|
102
|
+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
|
103
|
+
@echo
|
|
104
|
+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
|
105
|
+
|
|
106
|
+
latex:
|
|
107
|
+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
|
108
|
+
@echo
|
|
109
|
+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
|
110
|
+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
|
111
|
+
"(use \`make latexpdf' here to do that automatically)."
|
|
112
|
+
|
|
113
|
+
latexpdf:
|
|
114
|
+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
|
115
|
+
@echo "Running LaTeX files through pdflatex..."
|
|
116
|
+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
|
117
|
+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
|
118
|
+
|
|
119
|
+
latexpdfja:
|
|
120
|
+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
|
121
|
+
@echo "Running LaTeX files through platex and dvipdfmx..."
|
|
122
|
+
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
|
123
|
+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
|
124
|
+
|
|
125
|
+
text:
|
|
126
|
+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
|
127
|
+
@echo
|
|
128
|
+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
|
129
|
+
|
|
130
|
+
man:
|
|
131
|
+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
|
132
|
+
@echo
|
|
133
|
+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
|
134
|
+
|
|
135
|
+
texinfo:
|
|
136
|
+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
|
137
|
+
@echo
|
|
138
|
+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
|
139
|
+
@echo "Run \`make' in that directory to run these through makeinfo" \
|
|
140
|
+
"(use \`make info' here to do that automatically)."
|
|
141
|
+
|
|
142
|
+
info:
|
|
143
|
+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
|
144
|
+
@echo "Running Texinfo files through makeinfo..."
|
|
145
|
+
make -C $(BUILDDIR)/texinfo info
|
|
146
|
+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
|
147
|
+
|
|
148
|
+
gettext:
|
|
149
|
+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
|
150
|
+
@echo
|
|
151
|
+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
|
152
|
+
|
|
153
|
+
changes:
|
|
154
|
+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
|
155
|
+
@echo
|
|
156
|
+
@echo "The overview file is in $(BUILDDIR)/changes."
|
|
157
|
+
|
|
158
|
+
linkcheck:
|
|
159
|
+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
|
160
|
+
@echo
|
|
161
|
+
@echo "Link check complete; look for any errors in the above output " \
|
|
162
|
+
"or in $(BUILDDIR)/linkcheck/output.txt."
|
|
163
|
+
|
|
164
|
+
doctest:
|
|
165
|
+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
|
166
|
+
@echo "Testing of doctests in the sources finished, look at the " \
|
|
167
|
+
"results in $(BUILDDIR)/doctest/output.txt."
|
|
168
|
+
|
|
169
|
+
xml:
|
|
170
|
+
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
|
171
|
+
@echo
|
|
172
|
+
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
|
173
|
+
|
|
174
|
+
pseudoxml:
|
|
175
|
+
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
|
176
|
+
@echo
|
|
177
|
+
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
|
178
|
+
|
|
179
|
+
coverage:
|
|
180
|
+
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
|
|
181
|
+
|
|
182
|
+
livehtml:
|
|
183
|
+
sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|