Skip to content

Commit

Permalink
Merge pull request #17 from analog-garage/upload-source-dist
Browse files Browse the repository at this point in the history
conda-forge release
  • Loading branch information
analog-cbarber authored Jun 23, 2024
2 parents 0fb99b5 + bb3d548 commit 653ab51
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 26 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# mkdocstring-python-xref changes

## 1.6.1

* Available on conda-forge

## 1.6.0

* Added explicit option to disable cross-reference checking.
Expand Down
31 changes: 21 additions & 10 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ PACKAGE := mkdocstrings-python-xref
PACKAGE_VERSION_PATH := src/mkdocstrings_handlers/python_xref/VERSION
VERSION := $(strip $(file < $(PACKAGE_VERSION_PATH)))

SRC_FILES := $(wildcard src/mkdocstrings_handlers/garpy_python/*.py) $(PYTHON_VERSION_PATH)
SRC_FILES := $(wildcard src/mkdocstrings_handlers/python_xref/*.py) $(PYTHON_VERSION_PATH)

# Env names
DEV_ENV := mkxref-dev
Expand Down Expand Up @@ -145,17 +145,20 @@ lint: pylint mypy
WHEEL_FILE := dist/$(subst -,_,$(PACKAGE))-$(VERSION)-py3-none-any.whl
CONDA_FILE := dist/$(PACKAGE)-$(VERSION)-py_0.conda

build-sdist:
$(CONDA_RUN) python -m build --sdist --no-isolation --outdir dist

$(WHEEL_FILE):
$(CONDA_RUN) pip wheel . --no-deps --no-build-isolation -w dist

build-wheel: $(WHEEL_FILE)

$(CONDA_FILE): $(WHEEL_FILE)
$(CONDA_RUN) whl2conda build $(WHEEL_FILE)
$(CONDA_RUN) whl2conda convert $(WHEEL_FILE)

build-conda: $(CONDA_FILE)

build: build-wheel
build: build-wheel build-sdist build-conda

site/index.html: $(MKDOC_FILES) $(SRC_FILES)
$(CONDA_RUN) mkdocs build -f $(MKDOC_CONFIG)
Expand Down Expand Up @@ -193,16 +196,24 @@ doc-serve-all:

mike-serve: doc-serve-all

check-upload:
$(CONDA_RUN) twine check $(WHEEL_FILE)
check-upload-wheel:
$(CONDA_RUN) twine check dist/*.whl

check-upload-sdist:
$(CONDA_RUN) twine check dist/*.tar.gz

check-upload: check-upload-sdist check-upload-wheel

upload-wheel: check-upload-wheel
# NOTE: --skip-existing doesn't seem to actually work
$(CONDA_RUN) twine upload --skip-existing $(lastword $(sort $(wildcard dist/*.whl)))


upload: check-upload
upload-sdist: check-upload-sdist
# NOTE: --skip-existing doesn't seem to actually work
$(CONDA_RUN) twine upload --skip-existing $(WHEEL_FILE)
$(CONDA_RUN) twine upload --skip-existing $(lastword $(sort $(wildcard dist/*.tar.gz)))

anaconda-upload: $(CONDA_FILE)
# you will need to log in first
anaconda upload --user garpy $(CONDA_FILE)
upload: upload-sdist upload-wheel

clean-build:
-@$(RMDIR) build
Expand Down
5 changes: 1 addition & 4 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,5 @@ pip install mkdocstrings-python-xref
### Using conda

```
conda install -c garpy mkdocstrings-python-xref
conda install -c conda-forge mkdocstrings-python-xref
```



20 changes: 10 additions & 10 deletions environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@ channels:
dependencies:
# runtime
- python >=3.8,<3.13
- mkdocstrings-python >=1.5.2,<2.0
- mkdocstrings-python >=1.6.2,<1.10 # TODO: issue #18
# build
- hatchling >=1.18
- build >=0.7.0
- hatchling >=1.21
# test
- coverage >=7.3.0
- coverage >=7.4.0
- pytest >=7.4.0
- pytest-cov >=4.1.0
- pylint >=2.17.5
- mypy >=1.5.1
- mkdocs-material >=8.2
- pylint >=3.0.3
- mypy >=1.8
- beautifulsoup4 >=4.12
# documentation
- black >=23.7
- black >=23.12
- mike >=1.1,<2.0
- mkdocs >=1.5.0,<2.0
- mkdocs-material >=9.1
- linkchecker >=10.2.1
- mkdocs >=1.5.3,<2.0
- mkdocs-material >=9.5.4
- linkchecker >=10.4
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ keywords = [
dynamic = ["version"]
requires-python = ">=3.8"
dependencies = [
"mkdocstrings-python >=1.6.2,<2.0"
"mkdocstrings-python >=1.6.2,<1.10" # TODO: issue #18
]

[project.urls]
Expand Down
2 changes: 1 addition & 1 deletion src/mkdocstrings_handlers/python_xref/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.6.0
1.6.1

0 comments on commit 653ab51

Please sign in to comment.