Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
ff8e294
DOC: add missing docs
mj-will Aug 21, 2026
ed48530
DOC: add makefile for docs
mj-will Sep 8, 2026
71420d4
gitignore DS_Store files
cchapmanbird Sep 8, 2026
c6036f7
DOC: modify install instructions for PyPI release
cchapmanbird Sep 8, 2026
1abfb20
small tweaks
cchapmanbird Sep 8, 2026
c6e1601
tidy observations.rst
cchapmanbird Oct 8, 2026
5b457a9
doc: repoint examples.rst to sequnice-examples
cchapmanbird Oct 8, 2026
5e19ae5
fix formatting of AI_POLICY
cchapmanbird Oct 9, 2026
497bbcd
more docs improvements
cchapmanbird Oct 16, 2026
fb0c380
DOC: use autoapi to API docs
mj-will Oct 19, 2026
4ec7a83
DOC: fix code in getting started
mj-will Oct 19, 2026
3bd7462
DOC: fix sphinx reference warnings
mj-will Oct 19, 2026
58da6a3
DOC: simplify mutation and resampling docs
mj-will Oct 20, 2026
b8ef7bd
DOC: rename files
mj-will Oct 20, 2026
81b297b
DOC: add missing files
mj-will Oct 20, 2026
f7f3efe
DOC: update index
mj-will Oct 20, 2026
a4b1c8c
DOC: restructure and add more details
mj-will Oct 22, 2026
2e0b9ee
DOC: add section on documentation to contributing guidelines
mj-will Oct 22, 2026
879704b
DOC: link contributing guidelines and AI policy from docs
mj-will Oct 22, 2026
673fa33
DOC: change copyright and authors
mj-will Oct 22, 2026
e04ae88
DOC: fix developer guide
mj-will Oct 22, 2026
27ecedf
MAINT: fix invalid imports
mj-will Oct 22, 2026
588860b
add citation placeholder, merge getting started with index
cchapmanbird Oct 22, 2026
48ef05a
MAINT: merge main into update-docs
mj-will Oct 23, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
*.DS_Store

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
Expand Down
14 changes: 8 additions & 6 deletions AI_POLICY.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Usage of Generative AI

The sequince maintainers welcome contributions, including those developed with the assistance of generative AI tools. However, the use of such tools does not change our expectations for contributor responsibility, engagement, or code quality. The following apply to all contributions.
The Sequince maintainers welcome contributions, including those developed with the assistance of generative AI tools. However, the use of such tools does not change our expectations for contributor responsibility, engagement, or code quality. The following apply to all contributions.

1. **Human ownership and accountability**
i. Contributors are responsible for all submitted content, regardless of whether generative AI tools were used.
ii. Contributors must be able to explain and justify all changes during review.
iii. Contributors are responsible for ensuring all submitted code complies with Sequince's licensing requirements, regardless of whether generative AI tools were used.
iv. Contributors must remain the clear human owner of the contribution. Pull requests submitted primarily by automated systems or where no accountable human author is evident may be closed at the maintainers' discretion.
We require that:
- Contributors are responsible for all submitted content, regardless of whether generative AI tools were used.
- Contributors must be able to explain and justify all changes during review.
- Contributors are responsible for ensuring all submitted code complies with Sequince's licensing requirements, regardless of whether generative AI tools were used.
- Contributors must remain the clear human owner of the contribution. Pull requests submitted primarily by automated systems or where no accountable human author is evident may be closed at the maintainers' discretion.

2. **Engagement**
The pull request process is collaborative and iterative. Contributors are expected to actively engage with reviewer feedback themselves. Contributors are expected to understand the changes they are proposing, not act as a message courier for a third party.
Expand All @@ -20,5 +21,6 @@ The sequince maintainers welcome contributions, including those developed with t
5. **Maintainer discretion**
Maintainers may close or decline pull requests that are low quality, excessively burdensome to review, appear to lack meaningful human oversight, or otherwise are not in the best interests of the project.

> [!NOTE]
> **Note:**
>
> This policy is informed by similar guidance adopted in the Scientific Python ecosystem, including Astropy, Matplotlib, and scikit-learn.
22 changes: 20 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,12 @@ workflow and conventions we use to keep changes easy to review and maintain.

Treat other contributors with respect and follow the
[Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/).
Contributions must comply with the project's [license](LICENSE). Preserve required
Contributions must comply with the project's
[license](https://github.com/sequince-dev/sequince/blob/main/LICENSE). Preserve required
attribution when incorporating third-party material.

AI-assisted contributions are welcome under our [AI policy](AI_POLICY.md).
AI-assisted contributions are welcome under our
[AI policy](https://github.com/sequince-dev/sequince/blob/main/AI_POLICY.md).
Contributors are responsible for understanding, validating, and explaining their
changes, including their numerical correctness and performance.

Expand Down Expand Up @@ -157,6 +159,22 @@ def particle_mean(particles: Array) -> Array:
return xp.mean(particles, axis=0)
```

## Building the documentation

The documentation uses Sphinx and lives in `docs/`. From the repository root,
build the HTML documentation with the dedicated Pixi environment:

```bash
pixi run -e docs docs
```

Pixi installs the documentation dependencies defined in `pyproject.toml` when
preparing this environment. Open `docs/_build/html/index.html` in a browser to
review the result. Rebuild after editing documentation or API docstrings.

The developer guide embeds this file and `AI_POLICY.md` using MyST. Edit the
root Markdown files to update their content on GitHub and in the documentation.

## Checks and tests

Run the following checks before requesting review:
Expand Down
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
autoapi/
22 changes: 22 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help docs Makefile

docs: html

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
60 changes: 0 additions & 60 deletions docs/api/core.rst

This file was deleted.

9 changes: 0 additions & 9 deletions docs/api/index.rst

This file was deleted.

214 changes: 0 additions & 214 deletions docs/api/steps.rst

This file was deleted.

Loading
Loading