More changes before making public

Author: analog-cbarber

.gitlab-ci.yml

@@ -1,28 +1,6 @@
-# garpy.mkdocstring changes
+# mkdocstring-python-xref changes
 
-## 1.5.2.1
+## 1.6.2
 
-- Fix issue with 1.5.2
-
-## 1.5.2
-
-- Use mkdocstrings-python >=1.5.2,<2.0
-
-## 0.8.4
-
-- Restrict mkdocstrings-python to <1.4.0 (pending support for that version)
-
-## 0.8.3
-- Support `..` syntax for parent in addition to `^`
-- Deprecate use of `.` to be relative to parent when used in functions/methods.
-- Based on mkdocstrings-python >=1.1
-- Drop support for python 3.7
-
-## 0.8.2
-- Based on mkdocstrings-python >=0.8.2,<0.9
-- Support `(p)` specifier for enclosing package
-
-## 0.7.1 - Initial release.
-
-* support for relative cross-references
+First public release
 

CHANGELOG.md

@@ -1,18 +1,17 @@
-# Contributing to garpy.mkdocstrings
+# Contributing to mkdocstrings-python-xref
 
 ## Prerequisites
 
 * conda must be installed on your machine
-* make must be installed in your base conda environment
-* [garconda][] must be installed in your base conda environment
+* make should be installed in your base conda environment
 
 ## Development install
 
 To (re)create a conda development environment for this project run:
 
 ```
 make createdev
-conda activate garpy.mkdocstrings
+conda activate mkxref-dev
 ```
 
 After you have created the environment for the first time, you can configure your IDE
@@ -26,13 +25,10 @@ make updatedev
 
 This is just an optimization. If it does not work (e.g. can happen when switching to an old branch), just use `createdev`.
 
-## Versioning and Release process
+## Versioning
 
-This project follows the [basic garpy.* versioning and release process](https://gitlab.analog.com/boston-garage/garpy/-/blob/master/developer-docs/basic-release-process.md).
+The versions will generally track the version of [mkdocstrings_python][] on which it depends.
 
-At least initially, the versions will track the version of [mkdocstrings_python][] on which it depends.
-
-[garconda]: http://boston-garage.pages.gitlab.analog.com/garconda/
 [mkdocstrings_python]: https://github.com/mkdocstrings/python
 
 

CONTRIBUTING.md

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2021-2022 Analog Devices, Inc.
+   Copyright 2022-2023 Analog Devices, Inc.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

LICENSE.md

@@ -1,5 +1,4 @@
 CONDA := conda
-GARCONDA := garconda --min-version 0.3.4
 ECHO := echo
 RM := rm
 RMDIR := $(RM) -rf
@@ -24,12 +23,9 @@ COVERAGE_HTML := $(abspath htmlcov)
 -include custom.mk
 
 # General env/build/deploy args
-SRC := src
-
-PACKAGE := garpy.mkdocstrings
-PACKAGE_VERSION_PATH := $(SRC)/mkdocstrings_handlers/garpy_python/VERSION
-PACKAGE_COMMAND := $(CAT) $(PACKAGE_VERSION_PATH)
-PACKAGE_VER := $(shell $(PACKAGE_COMMAND))
+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)
 
@@ -45,18 +41,7 @@ CONDA_UPLOAD_CHANNEL := garage-conda-local$(UPLOAD_TEST)
 PYPI_UPLOAD_CHANNEL := adi-pypi-local$(UPLOAD_TEST)
 
 # Env names
-DEV_ENV := garpy.mkdocstrings
-
-# Creation args
-CREATE_DEV_ARGS := --file runtime-env.yml --file test-env.yml --file doc-env.yml
-GARCONDA_CREATE_ARGS := $(CREATE_DEV_ARGS)
-DEV_CREATE := $(GARCONDA) create-dev -n $(DEV_ENV) $(GARCONDA_CREATE_ARGS) --python-version 3.8
-CI_CREATE := $(DEV_CREATE)
-
-# Verify upload args
-VERIFY_UPLOAD := $(GARCONDA) verify-upload --expect-version $(PACKAGE_VER) --request-version $(PACKAGE_VER) $(PACKAGE)
-VERIFY_UPLOAD_CONDA := $(VERIFY_UPLOAD) --conda-channel $(CONDA_UPLOAD_CHANNEL)
-VERIFY_UPLOAD_WHEEL := $(VERIFY_UPLOAD) --pypi-channel $(PYPI_UPLOAD_CHANNEL)
+DEV_ENV := mkxref-dev
 
 # Whether to run targets in current env or explicitly in $(DEV_ENV)
 CURR_ENV_BASENAME := $(shell basename $(CONDA_PREFIX))
@@ -104,9 +89,9 @@ help:
 	@$(ECHO) "mypy            - Run mypy in '$(DEV_ENV)' environment."
 	@$(ECHO)
 	@$(ECHO) "$(SECTION_COLOR)--- build ---$(COLORLESS)"
-	@$(ECHO) "build           - Build wheel and conda package."
+	@$(ECHO) "build           - Build wheel"
 	@$(ECHO) "build-wheel     - Build wheel."
-	@$(ECHO) "build-conda     - Build conda package."
+	@$(ECHO) "build-conda     - Build conda package (requires whl2conda)"
 	@$(ECHO)
 	@$(ECHO) "$(SECTION_COLOR)--- upload ---$(COLORLESS)"
 	@$(ECHO) "upload          - Upload conda package and wheel to artifactory"
@@ -131,18 +116,22 @@ help:
 	@$(ECHO) "$(TOP_COLOR)====================$(COLORLESS)"
 	@$(ECHO)
 
+dev-install:
+	$(CONDA_RUN) pip install -e . --no-deps --no-build-isolation
+
 create-dev:
-	$(DEV_CREATE)
+	$(CONDA) env create -f environment.yml
+	$(MAKE) dev-install
 
 createdev: create-dev
 
 update-dev:
-	$(DEV_CREATE) --update
+	$(CONDA) env update -f environment.yml
+	$(MAKE) dev-install
 
 updatedev: update-dev
 
-create-ci-env:
-	$(CI_CREATE)
+create-ci-env: create-dev
 
 clean-dev:
 	-$(CONDA) env remove -n $(DEV_ENV)
@@ -152,18 +141,6 @@ pytest:
 
 test: lint pytest
 
-# We generate the tox dependency files from the official versions.
-tox-env.yml: runtime-env.yml test-env.yml
-	$(GARCONDA) env merge --out $@ $^
-
-tox-requirements.txt: runtime-env.yml test-env.yml
-	$(GARCONDA) env merge --for-pip --out $@ $^
-
-tox-dependencies: tox-env.yml tox-requirements.txt
-
-tox: tox-dependencies
-	$(CONDA_RUN) tox $(TOX_ARGS)
-
 test-all:  test tox
 
 .coverage:
@@ -183,35 +160,20 @@ mypy:
 
 lint: pylint mypy
 
-build-wheel:
-	$(CONDA_RUN) pip wheel . --no-deps --no-build-isolation -w dist
-
-conda-meta-data.json: runtime-env.yml pyproject.toml
-	$(CONDA_RUN) hatchling-garconda metadata --overwrite --out $@
-
-build-conda: conda-meta-data.json
-	$(GARCONDA) build $(abspath .)
-
-build-conda-no-test: conda-meta-data.json
-	$(GARCONDA) build $(abspath .) --no-test
+WHEEL_FILE := dist/$(subst -,_,$(PACKAGE))-$(VERSION)-py3-none-any.whl
+CONDA_FILE := dist/$(PACKAGE)-$(VERSION)-py_0.conda
 
-build: build-wheel build-conda
-
-upload-wheel:
-	$(GARCONDA) upload-pypi -u $(USERNAME) dist/* -c $(PYPI_UPLOAD_CHANNEL)
-
-upload-conda:
-	$(GARCONDA) upload '$(PACKAGE)-$(PACKAGE_VER)-*' -u $(USERNAME) -y -c $(CONDA_UPLOAD_CHANNEL) $(UPLOAD_OVERWRITE)
+$(WHEEL_FILE):
+	$(CONDA_RUN) pip wheel . --no-deps --no-build-isolation -w dist
 
-upload: upload-wheel upload-conda
+build-wheel: $(WHEEL_FILE)
 
-verify-upload-wheel:
-	$(CONDA_RUN) $(VERIFY_UPLOAD_WHEEL)
+$(CONDA_FILE): $(WHEEL_FILE)
+	$(CONDA_RUN) whl2conda build $(WHEEL_FILE)
 
-verify-upload-conda:
-	$(CONDA_RUN) $(VERIFY_UPLOAD_CONDA)
+build-conda: $(CONDA_FILE)
 
-verify-upload: verify-upload-wheel verify-upload-conda
+build: build-wheel
 
 site/index.html: $(MKDOC_FILES) $(SRC_FILES)
 	$(CONDA_RUN) mkdocs build -f $(MKDOC_CONFIG)

Makefile

@@ -1,13 +1,6 @@
-This project extends the standard python handler for mkdocstrings to support additional
-features.
+Python handler for [mkdocstrings] supporting relative cross-references.
 
-Currently this includes:
 
-* compact relative cross-references
 
-See [user documentation][user-doc] for usage details.
-
-See [developer docs][developer-doc] for development setup and information.
-
-[developer-doc]: CONTRIBUTING.md
-[user-doc]: http://boston-garage.pages.gitlab.analog.com/garpy.mkdocstrings/
+[mkdocstrings]: https://github.com/mkdocstrings/mkdocstrings
+[mkdocstrings_python]: https://github.com/mkdocstrings/python

README.md

@@ -1,5 +1,5 @@
 Configuration is the same as with [mkdocstrings-python][] except
-that the handler name should be `garpy_python` instead of `python`. Because
+that the handler name should be `python_xref` instead of `python`. Because
 this handler extends the standard [mkdocstrings-python][] handler, the same options are
 available.
 
@@ -14,9 +14,9 @@ Additional options are added by this extension. Currently, there is only one:
 plugins:
 - search
 - mkdocstrings:
-    default_handler: garpy_python
+    default_handler: python_xref
     handlers:
-      garpy_python:
+      python_xref:
         import:
         - https://docs.python.org/3/objects.inv
         options:

conda.recipe/meta.yaml

@@ -1,28 +1,8 @@
-### Using conda
-
-```
-conda install \
-   -c conda-forge \
-   -c https://artifactory.analog.com/artifactory/garage-conda-local \
-   garpy.mkdocstrings
-```
-
-Or if you have configured the garage-conda-local custom channel:
-
-```
-conda install -c conda-forge -c garage-conda-local garpy.config
-```
-
-or include entry in the appropriate conda environment YAML file for your project.
-
 ### Using pip
 
 ```
-pip install \
-   --extra-index-url https://artifactory.analog.com/artifactory/adi-pypi-local \
-   garpy.mkdocstrings
+pip install mkdocstrings-python-xref
 ```
 
-or include entry in the appropriate pip requirements.txt file for your project.