You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,8 +26,8 @@ SpatialData’s plotting capabilities allow to quickly visualise all contained m
26
26
27
27
For more information on the `spatialdata-plot` library, please refer to the [documentation](https://spatialdata.scverse.org/projects/plot/en/latest/index.html). In particular, the
Copy file name to clipboardExpand all lines: docs/contributing.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -82,11 +82,11 @@ out to the developers of the dependency before the package is released to a wide
82
82
83
83
Many tests will produce plots and check that they are correct by comparing them with a previously saved and serialized version of the same plots. The ground truth images are located in `tests/_images`. Different OS/versions may produce similar but not identical plots (for instance the ticks/padding could vary). To take into account for this please consider the following:
84
84
85
-
-you should not use locally generated plots as ground truth images, but you should commit images that have been generated by a GitHub Action. The recommended workflow is to go to the ["actions" page for the repo](https://github.com/scverse/spatialdata-plot/actions/workflows/test.yaml), download the artifacts, and upload them as ground truth (after having reviewed them).
86
-
-the ground truth images need to be updated when a new test is passing, or when a test starts producing a slightly different (but consistent) plot.
87
-
-please never replace the ground truth images without having manually reviewed them.
88
-
-if you run the tests locally in macOS or Windows they will likely fail because the ground truth images are generated using Ubuntu. To overcome this you can use `act`, which will generate a Docker reproducing the environment used in the GitHub Action. After the Docker container is generated you can use it within IDEs to run tests and debug code.
89
-
-in the case of PyCharm, it is easier to create a container from a `Dockerfile` instead of using `act`. Please in such case use the `Dockerfile` made availabel in the repository. If you encountering problems with `act` or `docker`, please [get in touch with the developers via Zulip](https://scverse.zulipchat.com/#narrow/channel/443514-spatialdata-dev) and we will help troubleshoot the issue. See also additional details [here](https://github.com/scverse/spatialdata-plot/pull/397).
85
+
- you should not use locally generated plots as ground truth images, but you should commit images that have been generated by a GitHub Action. The recommended workflow is to go to the ["actions" page for the repo](https://github.com/scverse/spatialdata-plot/actions/workflows/test.yaml), download the artifacts, and upload them as ground truth (after having reviewed them).
86
+
- the ground truth images need to be updated when a new test is passing, or when a test starts producing a slightly different (but consistent) plot.
87
+
- please never replace the ground truth images without having manually reviewed them.
88
+
- if you run the tests locally in macOS or Windows they will likely fail because the ground truth images are generated using Ubuntu. To overcome this you can use `act`, which will generate a Docker reproducing the environment used in the GitHub Action. After the Docker container is generated you can use it within IDEs to run tests and debug code.
89
+
- in the case of PyCharm, it is easier to create a container from a `Dockerfile` instead of using `act`. Please in such case use the `Dockerfile` made availabel in the repository. If you encountering problems with `act` or `docker`, please [get in touch with the developers via Zulip](https://scverse.zulipchat.com/#narrow/channel/443514-spatialdata-dev) and we will help troubleshoot the issue. See also additional details [here](https://github.com/scverse/spatialdata-plot/pull/397).
90
90
91
91
## Publishing a release
92
92
@@ -109,11 +109,11 @@ Specify `vX.X.X` as a tag name and create a release. For more information, see [
109
109
110
110
Please write documentation for new or changed features and use-cases. This project uses [sphinx][] with the following features:
111
111
112
-
-the [myst][] extension allows to write documentation in markdown/Markedly Structured Text
113
-
-[Numpy-style docstrings][numpydoc] (through the [napoloen][numpydoc-napoleon] extension).
114
-
-Jupyter notebooks as tutorials through [myst-nb][] (See [Tutorials with myst-nb](#tutorials-with-myst-nb-and-jupyter-notebooks))
115
-
-[Sphinx autodoc typehints][], to automatically reference annotated input and output types
116
-
-Citations (like {cite:p}`Virshup_2023`) can be included with [sphinxcontrib-bibtex](https://sphinxcontrib-bibtex.readthedocs.io/)
112
+
- the [myst][] extension allows to write documentation in markdown/Markedly Structured Text
113
+
-[Numpy-style docstrings][numpydoc] (through the [napoloen][numpydoc-napoleon] extension).
114
+
- Jupyter notebooks as tutorials through [myst-nb][] (See [Tutorials with myst-nb](#tutorials-with-myst-nb-and-jupyter-notebooks))
115
+
-[Sphinx autodoc typehints][], to automatically reference annotated input and output types
116
+
- Citations (like {cite:p}`Virshup_2023`) can be included with [sphinxcontrib-bibtex](https://sphinxcontrib-bibtex.readthedocs.io/)
117
117
118
118
See the [scanpy developer docs](https://scanpy.readthedocs.io/en/latest/dev/documentation.html) for more information
119
119
on how to write documentation.
@@ -130,10 +130,10 @@ repository.
130
130
131
131
#### Hints
132
132
133
-
-If you refer to objects from other packages, please add an entry to `intersphinx_mapping` in `docs/conf.py`. Only
134
-
if you do so can sphinx automatically create a link to the external documentation.
135
-
-If building the documentation fails because of a missing link that is outside your control, you can add an entry to
136
-
the `nitpick_ignore` list in `docs/conf.py`
133
+
- If you refer to objects from other packages, please add an entry to `intersphinx_mapping` in `docs/conf.py`. Only
134
+
if you do so can sphinx automatically create a link to the external documentation.
135
+
- If building the documentation fails because of a missing link that is outside your control, you can add an entry to
0 commit comments