Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ htmlcov/
.cache
.pytest_cache
.mypy_cache/
.entangled/

nosetests.xml
coverage.xml
Expand Down
12 changes: 6 additions & 6 deletions docs/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ jobs:
env:
# Replace MYPACKAGE with your actual package name (normalized)
# For package "my-awesome.package", use "MY_AWESOME_PACKAGE"
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{"local_scheme": "no-local-version"}'
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{local_scheme = "no-local-version"}'

steps:
- uses: actions/checkout@v4
Expand Down Expand Up @@ -154,7 +154,7 @@ jobs:
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
env:
# Replace MYPACKAGE with your actual package name (normalized)
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{"local_scheme": "no-local-version"}'
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{local_scheme = "no-local-version"}'

steps:
- uses: actions/checkout@v4
Expand Down Expand Up @@ -246,7 +246,7 @@ publish-test-pypi:
TWINE_USERNAME: __token__
TWINE_PASSWORD: $TEST_PYPI_API_TOKEN
# Replace MYPACKAGE with your actual package name (normalized)
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{"local_scheme": "no-local-version"}'
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{local_scheme = "no-local-version"}'
script:
- pip install build twine
- python -m build
Expand All @@ -261,7 +261,7 @@ publish-pypi:
TWINE_USERNAME: __token__
TWINE_PASSWORD: $PYPI_API_TOKEN
# Replace MYPACKAGE with your actual package name (normalized)
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{"local_scheme": "no-local-version"}'
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{local_scheme = "no-local-version"}'
script:
- pip install build twine
- python -m build
Expand Down Expand Up @@ -296,7 +296,7 @@ The environment variable `SETUPTOOLS_SCM_OVERRIDES_FOR_${DIST_NAME}` must be set

2. **Value** must be a valid TOML inline table format:
```bash
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE='{"local_scheme": "no-local-version"}'
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE='{local_scheme = "no-local-version"}'
```

#### Alternative Approaches
Expand Down Expand Up @@ -342,4 +342,4 @@ print(f"SETUPTOOLS_SCM_OVERRIDES_FOR_{env_var_name}")
# Output: SETUPTOOLS_SCM_OVERRIDES_FOR_MY_AWESOME_PACKAGE
```

**Fetch depth**: Always use `fetch-depth: 0` in GitHub Actions to ensure setuptools-scm has access to the full git history for proper version calculation.
**Fetch depth**: Always use `fetch-depth: 0` in GitHub Actions to ensure setuptools-scm has access to the full git history for proper version calculation.
2 changes: 1 addition & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ metadata is present.

The recommended approach for Sphinx configurations is to use the installed package metadata:

``` {.python file=docs/.entangled/sphinx_conf.py}
```python
from importlib.metadata import version as get_version
release: str = get_version("package-name")
# for example take major/minor
Expand Down
3 changes: 1 addition & 2 deletions hatch.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,4 @@ extras = ["docs"]
[envs.docs.scripts]
build = "mkdocs build --clean --strict"
serve = "mkdocs serve --dev-addr localhost:8000"
init = "mkdocs {args}"
sync = ["entangled sync"]
init = "mkdocs {args}"
1 change: 0 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ markdown_extensions:
- pymdownx.superfences

plugins:
- entangled
- search
- include-markdown
- mkdocstrings:
Expand Down
2 changes: 0 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,7 @@ toml = []

[dependency-groups]
docs = [
#"entangled-cli~=2.0",
"mkdocs",
"mkdocs-entangled-plugin",
"mkdocs-include-markdown-plugin",
"mkdocs-material",
"mkdocstrings[python]",
Expand Down
Loading
Loading