Publish the package and its documentation, and move to the papers organization

Add the Zensical documentation of the Python package (docs/package, built by the docs
workflow), merge the standard publish workflow with the setuptools-scm tag check, add the
SPDX header rule to ruff, restructure the README, and point every repository and registry
address at the Gitea organization papers.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01B8cL4zN4XpaQF5cBtASzfq
This commit is contained in:
alexmandClaude committed 2026-10-19 04:23:49 -04:00
1 parent bdbf03ebee
commit 30d310f64d
37 files changed
+1005 -83

No files matched your search

+14
View File
@@ -135,3 +135,17 @@ It is a minor change in the sense of [spec/00](spec/00-introduction.md): one new
- `fixtures/records/data/`, on the main example, with `vectors/data.jsonl` (35 cases): a valid case for each kind of data, annotations that break no rule and one or more that break each.
The layer ties the caption of Table 1 to its dataset as force-field parameters for ethane, water and the CT–CT pattern, the caption of Figure 1a to the dataset read from it as an energy profile of ethane, and the sentence that introduces Table 1 to the same dataset as a model's proposal.
The example project holds the layer, which changes `project.json`; no other fixture or vector changes.
Tooling and code quality only; no computed value, vector, fixture, schema or SQL file changes.
- The Python code meets the studio's standard: `ruff format`, `ruff check` with the full rule set, and `ty check` pass on `src/paperspec`, every function is annotated and documented, and `tests/` holds a pytest suite, driven by the vectors and fixtures, with branch coverage that fails under 90%.
`paperspec check` (with the byte-for-byte rebuild) and `paperspec stress` give the same results as before.
- Fixed: `structures.scan` raised an unrelated `ValueError` ("unsupported format character") for a malformed ring closure such as `C%1`, because its message was an invalid format string; the message is now "% needs two digits at N".
- Fixed: `paperspec site --out /` passed the check that the output folder does not contain the repository and went on to delete the folder it was given; it is now refused as a usage error.
- The pixi tasks follow the standard (`fmt`, `fmt-check`, `lint` for ruff, `typecheck`, `test`, `cov`, `hooks`); the Markdown lint is `lint-md`, `paperspec check` is also `verify`, and `check` runs them all.
The build environment is `release` (was `dev`), and `docs` builds the package documentation.
- The package documentation, for the Python package and its command, is built with Zensical from `docs/package/` and published at <https://docs.scient.ing/paperspec/>; the format documentation stays in `docs/` and on <https://paperspec.scient.ing>.
- The repository lives in the Gitea organization `papers`: the repository and registry addresses change from `infra` to `papers`.
- The publish workflow also creates the Gitea release, with the files attached and the notes taken from this changelog; CI runs the studio's checks (`.gitea/workflows/ci.yml`) on `main`, `dev` and pull requests.
- Python files open with an `SPDX-License-Identifier: Apache-2.0` header, which ruff and a test check.
- The checker and the site builder skip `work/`, caches and build output.