diff --git a/ADDING_PACKAGES.md b/ADDING_PACKAGES.md index 6e6471c22..5db9b1670 100644 --- a/ADDING_PACKAGES.md +++ b/ADDING_PACKAGES.md @@ -9,6 +9,7 @@ git clone git@github.com:scipp/essdiffraction.git /tmp/essdiffraction cd /tmp/essdiffraction git filter-repo --to-subdirectory-filter packages/essdiffraction --tag-rename ':essdiffraction/' cd /path/to/ess +git checkout -b adding-essdiffraction-package git remote add essdiffraction /tmp/essdiffraction git fetch essdiffraction --tags git merge essdiffraction/main --allow-unrelated-histories @@ -25,10 +26,17 @@ git remote remove essdiffraction tag_regex = "^essdiffraction/(?P[vV]?\\d+(?:\\.\\d+)*(?:[._-]?\\w+)*)$" git_describe_command = ["git", "describe", "--dirty", "--tags", "--long", "--match", "essdiffraction/*[0-9]*"] ``` -- Add `docs` extra with deps from `requirements/docs.in` (minus base deps) -- Remove unnecessary configurations in the pyproject.toml file. i.e. `tools.codespell`. +- Add `docs` extra with deps from `requirements/docs.in` (minus base deps), e.g.: + ```toml + docs = [ + "autodoc-pydantic", + "ipykernel", + "ipython!=8.7.0", + ] + ``` +- Remove unnecessary configurations in the pyproject.toml file. i.e. `[tool.codespell]`, `[tool.ruff]`, `[tool.ruff.lint]`, `[tool.ruff.format]`, etc - Delete unnecessary files: - `tox.ini`, `requirements/`, `.github/`, `.pre-commit-config.yaml`, `MANIFEST.in`, `.gitignore`, `.python-version`. + `tox.ini`, `requirements/`, `.github/`, `.pre-commit-config.yaml`, `CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, `LICENSE`, `MANIFEST.in`, `.gitignore`, `.python-version`. ## 3. Add to `pixi.toml` @@ -44,6 +52,9 @@ Docs feature: ```toml [feature.docs-essdiffraction.pypi-dependencies] essdiffraction = { path = "packages/essdiffraction", editable = true, extras = ["test", "docs"] } + +[feature.docs-essdiffraction.tasks.docs-essdiffraction] +cmd = "python -m sphinx -v -b html -d packages/essdiffraction/.docs_doctrees packages/essdiffraction/docs packages/essdiffraction/html" ``` Environments (include features for workspace dependencies, e.g. `essreduce`): @@ -62,4 +73,15 @@ Add a change filter and matrix entry. If the package depends on `essreduce`, inc ## 5. Run `pixi install` and commit +```bash +pixi install +git add -u +git commit -m "adding essdiffraction package" +``` + ## 6. Push the changes and tags with `essdiffraction` prefix. + +```bash +git push origin adding-essdiffraction-package +git push origin --tags +```