Skip to content

Commit 3ecf8be

Browse files
authored
cleanup (#8)
* cleanup * Cleanup
1 parent fcf03b0 commit 3ecf8be

File tree

7 files changed

+19
-127
lines changed

7 files changed

+19
-127
lines changed

.cruft.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
"checkout": null,
55
"context": {
66
"cookiecutter": {
7-
"project_name": "scverse-doc",
8-
"package_name": "scverse_doc",
7+
"project_name": "scverse-tutorials",
8+
"package_name": "scverse_tutorials",
99
"project_description": "A very interesting piece of code",
1010
"author_full_name": "Your Name",
1111
"author_email": "[email protected]",

README.md

Lines changed: 2 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# scverse-doc
1+
# scverse tutorials
22

33
[![Tests][badge-tests]][link-tests]
44
[![Documentation][badge-docs]][link-docs]
@@ -7,50 +7,4 @@
77
[link-tests]: https://github.com/your_github_username/scverse-doc/actions/workflows/test.yml
88
[badge-docs]: https://img.shields.io/readthedocs/scverse-doc
99

10-
A very interesting piece of code
11-
12-
## Getting started
13-
14-
Please refer to the [documentation][link-docs]. In particular, the
15-
16-
- [API documentation][link-api].
17-
18-
## Installation
19-
20-
You need to have Python 3.8 or newer installed on your system. If you don't have
21-
Python installed, we recommend installing [Mambaforge](https://github.com/conda-forge/miniforge#mambaforge).
22-
23-
There are several alternative options to install scverse-doc:
24-
25-
<!--
26-
1) Install the latest release of `scverse-doc` from `PyPI <https://pypi.org/project/scverse-doc/>`_:
27-
28-
```bash
29-
pip install scverse-doc
30-
```
31-
-->
32-
33-
1. Install the latest development version:
34-
35-
```bash
36-
pip install git+https://github.com/your_github_username/scverse-doc.git@main
37-
```
38-
39-
## Release notes
40-
41-
See the [changelog][changelog].
42-
43-
## Contact
44-
45-
For questions and help requests, you can reach out in the [scverse discourse][scverse-discourse].
46-
If you found a bug, please use the [issue tracker][issue-tracker].
47-
48-
## Citation
49-
50-
> t.b.a
51-
52-
[scverse-discourse]: https://discourse.scverse.org/
53-
[issue-tracker]: https://github.com/your_github_username/scverse-doc/issues
54-
[changelog]: https://scverse-doc.readthedocs.io/latest/changelog.html
55-
[link-docs]: https://scverse-doc.readthedocs.io
56-
[link-api]: https://scverse-doc.readthedocs.io/latest/api.html
10+
Collection of tutorials for scverse packages.

docs/api.md

Lines changed: 0 additions & 38 deletions
This file was deleted.

docs/changelog.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/index.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@
66
:hidden: true
77
:maxdepth: 1
88
9-
api.md
10-
changelog.md
11-
developer_docs.md
129
references.md
1310
1411
notebooks/example

docs/notebooks/example.ipynb

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@
7373
],
7474
"metadata": {
7575
"kernelspec": {
76-
"display_name": "Python 3",
76+
"display_name": "Python 3.6.8 64-bit",
7777
"language": "python",
7878
"name": "python3"
7979
},
@@ -87,7 +87,12 @@
8787
"name": "python",
8888
"nbconvert_exporter": "python",
8989
"pygments_lexer": "ipython3",
90-
"version": "3.8.13"
90+
"version": "3.6.8"
91+
},
92+
"vscode": {
93+
"interpreter": {
94+
"hash": "916dbcbb3f70747c44a77c7bcd40155683ae19c65e1c03b4aa3499c5328201f1"
95+
}
9196
}
9297
},
9398
"nbformat": 4,

pyproject.toml

Lines changed: 8 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,25 @@ requires = ["hatchling"]
44

55

66
[project]
7-
name = "scverse-doc"
7+
name = "scverse-tutorials"
88
version = "0.0.1"
9-
description = "A very interesting piece of code"
9+
description = "Tutorials for single-cell analysis with scverse packages"
1010
readme = "README.md"
1111
requires-python = ">=3.8"
1212
license = {file = "LICENSE"}
1313
authors = [
14-
{name = "Your Name"},
14+
{name = "scverse team"},
1515
]
1616
maintainers = [
17-
{name = "Your Name", email = "[email protected]"},
18-
]
19-
urls.Documentation = "https://scverse-doc.readthedocs.io/"
20-
urls.Source = "https://github.com/your_github_username/scverse-doc"
21-
urls.Home-page = "https://github.com/your_github_username/scverse-doc"
22-
dependencies = [
23-
"anndata",
24-
# for debug logging (referenced from the issue template)
25-
"session-info"
17+
{name = "scverse team", email = "[email protected]"},
2618
]
19+
urls.Documentation = "https://scverse.org/scverse-tutorials"
20+
urls.Source = "https://github.com/scverse/scverse-tutorials"
21+
urls.Home-page = "https://github.com/scverse/scverse-tutorials"
22+
dependencies = []
2723

2824
[project.optional-dependencies]
2925
dev = [
30-
# CLI for bumping the version number
31-
"bump2version",
3226
"pre-commit"
3327
]
3428
doc = [
@@ -41,23 +35,6 @@ doc = [
4135
"ipykernel",
4236
"sphinx-copybutton",
4337
]
44-
test = [
45-
"pytest",
46-
"pytest-cov",
47-
]
48-
49-
[tool.coverage.run]
50-
source = ["scverse_doc"]
51-
omit = [
52-
"**/test_*.py",
53-
]
54-
55-
[tool.pytest.ini_options]
56-
testpaths = ["tests"]
57-
xfail_strict = true
58-
addopts = [
59-
"--import-mode=importlib", # allow using test files with same name
60-
]
6138

6239
[tool.isort]
6340
include_trailing_comma = true

0 commit comments

Comments
 (0)