Skip to content

Commit a450da7

Browse files
committed
MAINT: Put more meaningful configuration info
1 parent 7886e44 commit a450da7

File tree

2 files changed

+20
-16
lines changed

2 files changed

+20
-16
lines changed

readme.md

+11-8
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,17 @@ demonstration.
1414

1515
## Representative Build Systems
1616

17-
| **Branch** | **Configuration** | **CI Status** |
18-
|------------------------------|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
19-
| `main` | Source, not to be run | N/A |
20-
| `setup.py-build` | Setuptools with `setup.py` | [![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=setup.py-build)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Asetup.py-build) |
21-
| `pyproject-setuptools-build` | Setuptools with `pyproject.toml` | [![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=pyproject-setuptools-build)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Apyproject-setuptools-build) |
22-
| `memray-plugin` | Setuptools with `pyproject.toml` | [![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=memray-plugin)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Amemray-plugin) |
23-
| `decorator-params` | Setuptools with `pyproject.toml` | [![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=decorator-params)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Adecorator-params) |
24-
| `skip-params` | Setuptools with `pyproject.toml` | [![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=skip-params)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Askip-params) |
17+
+CAPTION: Where not specified, `pyproject.toml` is coupled with `hatch`
18+
and `hatchling`
19+
20+
| **Branch** | **Configuration** | **CI Status** |
21+
|------------------------------|--------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
22+
| `main` | Source, not to be run | N/A |
23+
| `setup.py-build` | Setuptools with `setup.py` | [![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=setup.py-build)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Asetup.py-build) |
24+
| `pyproject-setuptools-build` | Setuptools with `pyproject.toml` | [![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=pyproject-setuptools-build)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Apyproject-setuptools-build) |
25+
| `memray-plugin` | `memray` usage for peak memory | [![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=memray-plugin)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Amemray-plugin) |
26+
| `decorator-params` | Decorators for simpler parametrization | [![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=decorator-params)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Adecorator-params) |
27+
| `skip-params` | Various benchmark / parameter skip methods | [![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=skip-params)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Askip-params) |
2528

2629
Note that in all cases users can always modify the `build_command`
2730
variable within their `asv` configuration file.

readme_src.org

+9-8
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,15 @@ The repository is structured with dedicated branches for each build system and
1111
feature demonstration.
1212
** Representative Build Systems
1313

14-
| *Branch* | *Configuration* | *CI Status* |
15-
|------------------------------+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------|
16-
| ~main~ | Source, not to be run | N/A |
17-
| ~setup.py-build~ | Setuptools with ~setup.py~ | @@markdown:[![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=setup.py-build)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Asetup.py-build)@@ |
18-
| ~pyproject-setuptools-build~ | Setuptools with ~pyproject.toml~ | @@markdown:[![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=pyproject-setuptools-build)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Apyproject-setuptools-build)@@ |
19-
| ~memray-plugin~ | Setuptools with ~pyproject.toml~ | @@markdown:[![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=memray-plugin)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Amemray-plugin)@@ |
20-
| ~decorator-params~ | Setuptools with ~pyproject.toml~ | @@markdown:[![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=decorator-params)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Adecorator-params)@@ |
21-
| ~skip-params~ | Setuptools with ~pyproject.toml~ | @@markdown:[![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=skip-params)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Askip-params)@@ |
14+
+CAPTION: Where not specified, ~pyproject.toml~ is coupled with ~hatch~ and ~hatchling~
15+
| *Branch* | *Configuration* | *CI Status* |
16+
|------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
17+
| ~main~ | Source, not to be run | N/A |
18+
| ~setup.py-build~ | Setuptools with ~setup.py~ | @@markdown:[![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=setup.py-build)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Asetup.py-build)@@ |
19+
| ~pyproject-setuptools-build~ | Setuptools with ~pyproject.toml~ | @@markdown:[![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=pyproject-setuptools-build)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Apyproject-setuptools-build)@@ |
20+
| ~memray-plugin~ | ~memray~ usage for peak memory | @@markdown:[![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=memray-plugin)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Amemray-plugin)@@ |
21+
| ~decorator-params~ | Decorators for simpler parametrization | @@markdown:[![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=decorator-params)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Adecorator-params)@@ |
22+
| ~skip-params~ | Various benchmark / parameter skip methods | @@markdown:[![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=skip-params)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Askip-params)@@ |
2223

2324
Note that in all cases users can always modify the ~build_command~ variable
2425
within their ~asv~ configuration file.

0 commit comments

Comments
 (0)