Skip to content

Commit 7425778

Browse files
committed
refactor: rename docs -> rtd for check family
Signed-off-by: Henry Schreiner <[email protected]>
1 parent 8952905 commit 7425778

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -338,13 +338,6 @@ for family, grp in itertools.groupby(collected.checks.items(), key=lambda x: x[1
338338
- [`PP308`](https://learn.scientific-python.org/development/guides/pytest#PP308): Specifies useful pytest summary
339339
- [`PP309`](https://learn.scientific-python.org/development/guides/pytest#PP309): Filter warnings specified
340340

341-
### Documentation
342-
- [`RTD100`](https://learn.scientific-python.org/development/guides/docs#RTD100): Uses ReadTheDocs (pyproject config)
343-
- [`RTD101`](https://learn.scientific-python.org/development/guides/docs#RTD101): You have to set the RTD version number to 2
344-
- [`RTD102`](https://learn.scientific-python.org/development/guides/docs#RTD102): You have to set the RTD build image
345-
- [`RTD103`](https://learn.scientific-python.org/development/guides/docs#RTD103): You have to set the RTD python version
346-
- [`RTD104`](https://learn.scientific-python.org/development/guides/docs#RTD104): You have to specify a build configuration now for readthedocs.
347-
348341
### GitHub Actions
349342
- [`GH100`](https://learn.scientific-python.org/development/guides/gha-basic#GH100): Has GitHub Actions config
350343
- [`GH101`](https://learn.scientific-python.org/development/guides/gha-basic#GH101): Has nice names
@@ -388,6 +381,13 @@ for family, grp in itertools.groupby(collected.checks.items(), key=lambda x: x[1
388381
- [`PC902`](https://learn.scientific-python.org/development/guides/style#PC902): Custom pre-commit CI autofix message
389382
- [`PC903`](https://learn.scientific-python.org/development/guides/style#PC903): Specified pre-commit CI schedule
390383

384+
### ReadTheDocs
385+
- [`RTD100`](https://learn.scientific-python.org/development/guides/docs#RTD100): Uses ReadTheDocs (pyproject config)
386+
- [`RTD101`](https://learn.scientific-python.org/development/guides/docs#RTD101): You have to set the RTD version number to 2
387+
- [`RTD102`](https://learn.scientific-python.org/development/guides/docs#RTD102): You have to set the RTD build image
388+
- [`RTD103`](https://learn.scientific-python.org/development/guides/docs#RTD103): You have to set the RTD python version
389+
- [`RTD104`](https://learn.scientific-python.org/development/guides/docs#RTD104): You have to specify a build configuration now for readthedocs.
390+
391391
### Ruff
392392
- [`RF001`](https://learn.scientific-python.org/development/guides/style#RF001): Has Ruff config
393393
- [`RF002`](https://learn.scientific-python.org/development/guides/style#RF002): Target version must be set

src/sp_repo_review/checks/readthedocs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212

1313
class ReadTheDocs:
14-
family = "docs"
14+
family = "rtd"
1515
url = mk_url("docs")
1616

1717

src/sp_repo_review/families.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,8 @@ def get_families(
121121
name="Ruff",
122122
description=ruff_description(ruff),
123123
),
124-
"docs": Family(
125-
name="Documentation",
124+
"rtd": Family(
125+
name="ReadTheDocs",
126126
),
127127
"setupcfg": Family(
128128
name="Setuptools Config",

0 commit comments

Comments
 (0)