change to dynamic versioning, change doc build

Author: melonora

.github/workflows/pypi.yml

@@ -47,8 +47,13 @@ class Image(AsDataArray):
 
 ### Installation
 
+There are multiple ways you can install xarray-dataclasses, dependent on what kind of dependency manager you use.
+
 ```shell
 pip install xarray-dataclasses
+conda install -c conda-forge xarray-dataclasses
+pixi add xarray-dataclasses
+pixi add --pypi xarray-dataclasses
 ```
 
 ## Basic usage
@@ -339,6 +344,69 @@ class Image:
 image = asdataarray(Image([[0, 1], [2, 3]], [0, 1], [0, 1]))
 ```
 
+## How to contribute
+
+Thank you for being willing to contribute! If you have some ideas to propose, please open an [issue](https://github.com/xarray-contrib/xarray-dataclasses/issues).
+We use [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow) for developing and managing the project.
+The first section describes how to contribute with it.
+The second and third sections explain how to prepare a local development environment and our automated workflows in GitHub Actions, respectively.
+
+
+### Get the source code
+
+```shell
+git clone https://github.com/xarray-contrib/xarray-dataclasses
+cd xarray-dataclasses
+```
+
+### Install dependencies
+
+First install [pixi](https://pixi.sh/latest/installation/). Then, install project dependencies:
+
+```shell
+pixi install -a
+pixi run pre-commit-install
+```
+
+### Testing, linting, and formatting
+We have [a test workflow][test-workflow] for testing, static type checking, linting, and formatting the code.
+It is used for status checks when a pull request is created.
+If you would like to check them in local, the following commands are almost equivalent (the difference is that the workflow is run under multiple Python versions).
+Furthermore, these tasks are defined only in the `dev` environment. Pixi does not require you to specify the environment
+in that case.
+
+```shell
+pixi run tests
+pixi run flake8
+pixi run black
+pixi run pyright
+```
+
+### Creating documentation
+We also have a [documentation workflow] (Add link). However, if you want to locally create the documentation 
+run the following:
+
+```shell
+pixi run doc_build
+```
+
+### Create a release
+
+This section is relevant only for maintainers.
+
+1. Pull `git`'s `main` branch.
+2. `pixi install -a`
+3. `pixi run pre-commit-install`
+4. `pixi run -e test test`
+5. `pixi shell`
+6. `hatch version <new-version>`
+7. `git add .`
+8. `git commit -m "ENH: Bump version to <version>"`
+9. `hatch build`
+10. `hatch publish`
+11. `git push upstream main`
+12. Create a new tag and Release via the GitHub UI. Auto-generate release notes
+    and add additional notes as needed.
 
 <!-- References -->
 [Pyright]: https://github.com/microsoft/pyright

README.md

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "xarray-dataclasses"
-version = "1.9.1"
+dynamic = ["version"]
 description = "xarray data creation by data classes"
 authors = [
     {name = "Akio Taniguchi", email = "[email protected]"},
@@ -24,16 +24,16 @@ classifiers = [
 ]
 keywords = ["xarray", "dataclass", "dataarray", "dataset", "typing"]
 
-requires-python = ">=3.8, <3.14"
+requires-python = ">=3.9, <3.14"
 dependencies = [
     "numpy >=2.0.0,<3",
     "xarray >=2022.3,<2026",
     "typing-extensions>=4.10.0,<5"]
 
 [project.urls]
-Homepage = "https://github.com/melonora/xarray-dataclasses/"
-Repository = "https://github.com/melonora/xarray-dataclasses/"
-Documentation = "https://melonora.github.io/xarray-dataclasses/"
+Homepage = "https://github.com/xarray-contrib/xarray-dataclasses/"
+Repository = "https://github.com/xarray-contrib/xarray-dataclasses/"
+Documentation = "https://xarray-contrib.github.io/xarray-dataclasses/"
 
 
 [project.optional-dependencies]
@@ -56,6 +56,9 @@ include = [
     "LICENSE"
 ]
 
+[tool.hatch.version]
+path = "src/xarray_dataclasses/__about__.py"
+
 [tool.hatch.build.targets.wheel]
 packages = ["src/xarray_dataclasses"]
 
@@ -68,8 +71,11 @@ default = { solve-group = "default" }
 dev = { features = ["dev"], solve-group = "default" }
 
 [tool.pixi.feature.dev.tasks]
-test = "pytest"
-doc_build = "python -m sphinx -b html docs docs/_build"
+tests = "pytest"
+flake8 = "flake8 docs tests src/xarray_dataclasses"
+black = "black --check docs tests xarray_dataclasses"
+doc_build = { cmd = "sphinx-apidoc -efT -o docs/_apidoc src/xarray_dataclasses && sphinx-build -a docs docs/_build" }
+pyright = "pyright docs tests src/xarray_dataclasses"
 
 [tool.pyright]
 reportImportCycles = "warning"

docs/build

@@ -0,0 +1,2 @@
+# SPDX-License-Identifier: MIT
+__version__ = "1.9.1"

pixi.lock

@@ -16,8 +16,8 @@
     "datamodel",
     "dataoptions",
     "typing",
+    "__version__"
 ]
-__version__ = "1.9.1"
 
 
 # submodules
@@ -26,6 +26,7 @@
 from . import datamodel
 from . import dataoptions
 from . import typing
+from .__about__ import __version__
 from .dataarray import *
 from .dataset import *
 from .datamodel import *