Merge pull request #20 from srivarra/pre-commit-ci-update-config

.pre-commit-config.yaml

@@ -15,7 +15,7 @@ repos:
     hooks:
       - id: pyproject-fmt
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.8.1
+    rev: v0.8.3
     hooks:
       - id: ruff
         types_or: [python, pyi, jupyter]

CHANGELOG.md

@@ -9,46 +9,46 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
--   ✅ Added sparsity X tests
--   ♻️ Refactor \_extract_X
--   📝 Clean notebook
--   ✅ Updated x tests
--   Merge branch 'main' into docs/restructure
--   Merge pull request #8 from srivarra/pre-commit-ci-update-config
--   [pre-commit.ci] pre-commit autoupdate
--   ✅ Add pipe tests
--   📝 Added scanpy plot with pipe
--   🎨 Format pyproject.toml
--   📝 Updated landing page
--   📝 Updated documentation structure
+- ✅ Added sparsity X tests
+- ♻️ Refactor \_extract_X
+- 📝 Clean notebook
+- ✅ Updated x tests
+- Merge branch 'main' into docs/restructure
+- Merge pull request #8 from srivarra/pre-commit-ci-update-config
+- [pre-commit.ci] pre-commit autoupdate
+- ✅ Add pipe tests
+- 📝 Added scanpy plot with pipe
+- 🎨 Format pyproject.toml
+- 📝 Updated landing page
+- 📝 Updated documentation structure
 
 ## [0.0.1] - 2024-11-10
 
 ### Changed
 
--   Merge pull request #5 from srivarra/ci_release_fix
--   💚 Release fixes
--   Merge pull request #4 from srivarra/filter
--   📝 Remove nbsphinx
--   ➖ Remove pytest rich
--   ✨ Filter mostly fixed
--   📝 Add a link to the discussions.
--   ✅ Dataclasses from attrs again
--   🏷️ Fixed dataclasses
--   ✨ Fixed up filtering
--   Merge pull request #1 from srivarra/configuration
--   📝 Do not fail on warning
--   💚 Removed upload test results to codecov
--   📝 Added matplotlib to docs
--   📝 Update rtd
--   📝 Fix rtd
--   🧑‍💻 Added gitcliff changelog
--   💚 Added python 3.12 to test suite
--   ♻️ Renamed accessor
--   ➖ Removed twine
--   ➕ Added twine
--   ➕ Added pytest extra deps
--   🎉 Begin
+- Merge pull request #5 from srivarra/ci_release_fix
+- 💚 Release fixes
+- Merge pull request #4 from srivarra/filter
+- 📝 Remove nbsphinx
+- ➖ Remove pytest rich
+- ✨ Filter mostly fixed
+- 📝 Add a link to the discussions.
+- ✅ Dataclasses from attrs again
+- 🏷️ Fixed dataclasses
+- ✨ Fixed up filtering
+- Merge pull request #1 from srivarra/configuration
+- 📝 Do not fail on warning
+- 💚 Removed upload test results to codecov
+- 📝 Added matplotlib to docs
+- 📝 Update rtd
+- 📝 Fix rtd
+- 🧑‍💻 Added gitcliff changelog
+- 💚 Added python 3.12 to test suite
+- ♻️ Renamed accessor
+- ➖ Removed twine
+- ➕ Added twine
+- ➕ Added pytest extra deps
+- 🎉 Begin
 
 [unreleased]: https://github.com///compare/0.0.1..HEAD
 

docs/contributing.md

@@ -155,11 +155,11 @@ This will automatically create a git tag and trigger a Github workflow that crea
 Please write documentation for new or changed features and use-cases.
 This project uses [sphinx][] with the following features:
 
--   The [myst][] extension allows to write documentation in markdown/Markedly Structured Text
--   [Numpy-style docstrings][numpydoc] (through the [napoloen][numpydoc-napoleon] extension).
--   Jupyter notebooks as tutorials through [myst-nb][] (See [Tutorials with myst-nb](#tutorials-with-myst-nb-and-jupyter-notebooks))
--   [sphinx-autodoc-typehints][], to automatically reference annotated input and output types
--   Citations (like {cite:p}`Virshup_2023`) can be included with [sphinxcontrib-bibtex](https://sphinxcontrib-bibtex.readthedocs.io/)
+- The [myst][] extension allows to write documentation in markdown/Markedly Structured Text
+- [Numpy-style docstrings][numpydoc] (through the [napoloen][numpydoc-napoleon] extension).
+- Jupyter notebooks as tutorials through [myst-nb][] (See [Tutorials with myst-nb](#tutorials-with-myst-nb-and-jupyter-notebooks))
+- [sphinx-autodoc-typehints][], to automatically reference annotated input and output types
+- Citations (like {cite:p}`Virshup_2023`) can be included with [sphinxcontrib-bibtex](https://sphinxcontrib-bibtex.readthedocs.io/)
 
 See scanpy’s {doc}`scanpy:dev/documentation` for more information on how to write your own.
 
@@ -183,10 +183,10 @@ please check out [this feature request][issue-render-notebooks] in the `cookiecu
 
 #### Hints
 
--   If you refer to objects from other packages, please add an entry to `intersphinx_mapping` in `docs/conf.py`.
-    Only if you do so can sphinx automatically create a link to the external documentation.
--   If building the documentation fails because of a missing link that is outside your control,
-    you can add an entry to the `nitpick_ignore` list in `docs/conf.py`
+- If you refer to objects from other packages, please add an entry to `intersphinx_mapping` in `docs/conf.py`.
+  Only if you do so can sphinx automatically create a link to the external documentation.
+- If building the documentation fails because of a missing link that is outside your control,
+  you can add an entry to the `nitpick_ignore` list in `docs/conf.py`
 
 (docs-building)=